Updated documentation

This commit is contained in:
2024-08-26 12:46:47 +02:00
parent b35b17bb32
commit 63d72c8d22
4 changed files with 138 additions and 135 deletions

39
docs/readme.md Normal file
View File

@ -0,0 +1,39 @@
# q
A programming language that compiles down to machine code.
## Features
- Fast compilation
- High performance
- Small executables
## Installation
```shell
git clone https://git.akyoto.dev/cli/q
cd q
go build
```
## Usage
```shell
./q run examples/hello
```
Builds an executable from `examples/hello` and runs it.
## Links
- [Chat](https://matrix.to/#/#community:akyoto.dev)
- [Donate](https://buy.stripe.com/4gw7vf5Jxflf83m7st)
- [Todo](/docs/todo.md)
## License
Please see the [license documentation](https://akyoto.dev/license).
## Copyright
© 2023 Eduard Urbach