diff --git a/docs/readme.md b/docs/readme.md index 5873bd8..2eb5384 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,15 +1,15 @@ # 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 - High performance - Small executables - Zero dependencies -## Installation +## ⚙️ Installation ```shell 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`. -## Usage +## ⚡️ Usage ```shell q run examples/hello @@ -27,7 +27,7 @@ q run examples/hello You can take a look at the [examples](../examples). -## Tests +## 🚦 Tests ```shell 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. -## Platforms +## 💻 Platforms 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 ``` -## 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. 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). -## License +## 📃 License Please see the [license documentation](https://urbach.dev/license). -## Copyright +## 👤 Copyright © 2023 Eduard Urbach diff --git a/docs/todo.md b/docs/todo.md index e08b1d2..3e18782 100644 --- a/docs/todo.md +++ b/docs/todo.md @@ -49,6 +49,7 @@ - [x] Exclude unused functions - [x] Constant folding +- [ ] SSA form - [ ] Constant propagation - [ ] Function call inlining - [ ] Loop unrolls