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

Updated documentation
All checks were successful
/ test (push) Successful in 15s
Details

Browse source
This commit is contained in:
Eduard Urbach 2025-07-07 17:37:36 +02:00
parent 031edd2ffe
commit 009472e6a8
Signed by: akyoto
GPG key ID: 49226B848C78F6C8
1 changed files with 10 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/readme.md
View file

@ -24,6 +24,12 @@ cd q
go build
```
Add a symlink in `~/.local/bin` or `/usr/local/bin`:
```shell
ln -s $PWD/q ~/.local/bin/q
```
## Usage
Quick test:
@ -46,7 +52,7 @@ q build examples/hello --os windows
### Unix scripts
The compiler is actually so fast that it's possible to use `q` for scripting. Create a new file:
The compiler is actually so fast that it's possible to use `q` for scripting. Create a new file...
```q
#!/usr/bin/env q
@ -58,8 +64,9 @@ main() {
}
```
Add permissions via `chmod +x`. The file can be executed from anywhere now.
The machine code is run directly from memory if the OS supports it.
...and add exec permissions via `chmod +x`. The file can be executed from anywhere now.
The generated machine code is run directly from memory if the OS supports it.
## Tests