Updated documentation
This commit is contained in:
39
docs/readme.md
Normal file
39
docs/readme.md
Normal 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
|
Reference in New Issue
Block a user