Updated documentation
This commit is contained in:
parent
3b76919fec
commit
4cff697bf5
@ -17,38 +17,23 @@ cd q
|
||||
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`.
|
||||
Either use `./q` from the build directory or get access to the shorter `q` in any directory with `ln -s $PWD/q ~/.local/bin/q`.
|
||||
|
||||
## Examples
|
||||
|
||||
You can take a look at the [examples](../examples).
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
q run examples/hello
|
||||
```
|
||||
|
||||
## Usage
|
||||
You can take a look at the [examples](../examples).
|
||||
|
||||
## Tests
|
||||
|
||||
```shell
|
||||
go run gotest.tools/gotestsum@latest
|
||||
```
|
||||
Usage:
|
||||
|
||||
q [command] [options]
|
||||
|
||||
Commands:
|
||||
|
||||
build [directory | file] build an executable from a file or directory
|
||||
--arch [arch] cross-compile for another CPU architecture [x86|arm|riscv]
|
||||
--assembly, -a show assembly instructions
|
||||
--dry, -d skip writing the executable to disk
|
||||
--os [os] cross-compile for another OS [linux|mac|windows]
|
||||
--statistics, -s show statistics
|
||||
--verbose, -v show everything
|
||||
|
||||
run [directory | file] build and run the executable
|
||||
system show system information
|
||||
help show this help
|
||||
```
|
||||
This will run over 350 tests in various categories.
|
||||
|
||||
## Platforms
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user