cli/q
Code Issues 1 Pull Requests Activity

Updated documentation

Browse Source
This commit is contained in:
Eduard Urbach
2025-03-18 18:24:30 +01:00
parent eb27595593
commit 89654500e0
2 changed files with 17 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/readme.md
View File

@ -1,15 +1,15 @@
# q # q
A programming language that quickly compiles to machine code without gigantic dependencies like LLVM. A programming language that quickly compiles to machine code.
## Goals ## 🎯 Goals
- Fast compilation - Fast compilation
- High performance - High performance
- Small executables - Small executables
- Zero dependencies - Zero dependencies
## Installation ## ⚙️ Installation
```shell ```shell
git clone https://git.urbach.dev/cli/q git clone https://git.urbach.dev/cli/q
@ -19,7 +19,7 @@ go build
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`. 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`.
## Usage ## ⚡️ Usage
```shell ```shell
q run examples/hello q run examples/hello
@ -27,7 +27,7 @@ q run examples/hello
You can take a look at the [examples](../examples). You can take a look at the [examples](../examples).
## Tests ## 🚦 Tests
```shell ```shell
go run gotest.tools/gotestsum@latest go run gotest.tools/gotestsum@latest
@ -35,7 +35,7 @@ go run gotest.tools/gotestsum@latest
This will run over 400 [tests](../tests) in various categories. This will run over 400 [tests](../tests) in various categories.
## Platforms ## 💻 Platforms
You can cross-compile executables for Linux, Mac and Windows. You can cross-compile executables for Linux, Mac and Windows.
@ -45,17 +45,24 @@ q build examples/hello --os mac
q build examples/hello --os windows q build examples/hello --os windows
``` ```
## Status Or with different architectures:
```shell
q build examples/hello --arch x86
q build examples/hello --arch arm
```
## ⚠️ Status
`q` is under heavy development and not ready for production yet. `q` is under heavy development and not ready for production yet.
Feel free to [get in touch](https://urbach.dev/contact) if you are interested in helping out. Feel free to [get in touch](https://urbach.dev/contact) if you are interested in helping out.
The biggest obstacle right now is the lack of funding. You can help by donating via [Kofi](https://ko-fi.com/akyoto) or [Open Collective](https://opencollective.com/qlang). The biggest obstacle right now is the lack of funding. You can help by donating via [Kofi](https://ko-fi.com/akyoto) or [Open Collective](https://opencollective.com/qlang).
## License ## 📃 License
Please see the [license documentation](https://urbach.dev/license). Please see the [license documentation](https://urbach.dev/license).
## Copyright ## 👤 Copyright
© 2023 Eduard Urbach © 2023 Eduard Urbach

1
docs/todo.md
View File

@ -49,6 +49,7 @@
- [x] Exclude unused functions - [x] Exclude unused functions
- [x] Constant folding - [x] Constant folding
- [ ] SSA form
- [ ] Constant propagation - [ ] Constant propagation
- [ ] Function call inlining - [ ] Function call inlining
- [ ] Loop unrolls - [ ] Loop unrolls