cli/q
1
0
Fork 0
Code Issues Pull requests Releases Activity

Updated documentation

Browse source
This commit is contained in:
Eduard Urbach 2025-02-17 11:15:59 +01:00
parent 7951136234
commit 4bc4e7ef05
Signed by: eduard
GPG key ID: 49226B848C78F6C8
1 changed files with 4 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/readme.md
View file

@ -18,17 +18,16 @@ go build
```
This will place the compiler inside the repository.
Either use `./q` or get access to the shorter `q` in any directory with `ln -s $PWD/q ~/.local/bin/q`.
### Symlink
## Examples
Either use `./q` for the following examples or get access to the shorter `q` in any directory via symlink:
You can take a look at the [examples](examples).
```shell
ln -s $PWD/q ~/.local/bin/q
q run examples/hello
```
This assumes that your shell loads `~/.local/bin`.
## Usage
```