diff --git a/docs/readme.md b/docs/readme.md index 226b622..b916b66 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -2,14 +2,54 @@ A programming language that quickly compiles to machine code. +## Goals + +- Fast compilation +- High performance +- Tiny executables + +## Installation + +```shell +git clone https://git.urbach.dev/cli/q +cd q +go build +``` + +## Usage + +```shell +q build examples/hello +./examples/hello/hello +``` + +## Tests + +```shell +go run gotest.tools/gotestsum@latest +``` + ## Platforms +You can cross-compile executables for Linux, Mac and Windows using arm64 or x86-64. + +```shell +q build examples/hello --os linux +q build examples/hello --os mac +q build examples/hello --os windows +q build examples/hello --arch x86 +q build examples/hello --arch arm +``` + | CPU | Linux | Mac | Windows | | ------ | ----- | --- | ------- | -| arm64 | ✅ | ❔ | ❔ | -| x86-64 | ✅ | ✅ | ✅ | +| arm64 | ✔️ | ❔ | ❔ | +| x86-64 | ✔️ | ✔️ | ✔️ | -Those marked with a ❔ are theoretically supported but there are no developer machines to test them. +## 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. ## License