Updated documentation
This commit is contained in:
parent
07c7e69078
commit
2d8fe15abb
28
README.md
28
README.md
@ -1,11 +1,11 @@
|
|||||||
# q
|
# q
|
||||||
|
|
||||||
A simple programming language.
|
A programming language for use in systems programming, game development and web servers.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
* Fast compilation
|
* Fast compilation
|
||||||
* Small binaries
|
* Small executables
|
||||||
* High performance
|
* High performance
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
@ -24,6 +24,18 @@ Build an executable from `examples/hello` and run it:
|
|||||||
./q run examples/hello
|
./q run examples/hello
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Tests
|
||||||
|
|
||||||
|
```shell
|
||||||
|
go test ./... -v -cover
|
||||||
|
```
|
||||||
|
|
||||||
|
## Benchmarks
|
||||||
|
|
||||||
|
```shell
|
||||||
|
go test ./tests -run='^$' -bench=. -benchmem
|
||||||
|
```
|
||||||
|
|
||||||
## Todo
|
## Todo
|
||||||
|
|
||||||
### Compiler
|
### Compiler
|
||||||
@ -178,18 +190,6 @@ This is what generates the AST from tokens.
|
|||||||
|
|
||||||
This is what generates expressions from tokens.
|
This is what generates expressions from tokens.
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
```shell
|
|
||||||
go test ./... -v -cover
|
|
||||||
```
|
|
||||||
|
|
||||||
## Benchmarks
|
|
||||||
|
|
||||||
```shell
|
|
||||||
go test ./tests -bench=. -benchmem
|
|
||||||
```
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Please see the [license documentation](https://akyoto.dev/license).
|
Please see the [license documentation](https://akyoto.dev/license).
|
||||||
|
Loading…
Reference in New Issue
Block a user