q/docs/readme.md
Eduard Urbach 917dc081b1
All checks were successful
/ test (push) Successful in 17s
Updated documentation
2025-07-05 14:15:35 +02:00

60 lines
No EOL
1.1 KiB
Markdown

# q
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 | ✔️ | ✔️ | ✔️ |
## 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
Please see the [license documentation](https://urbach.dev/license).
## Copyright
© 2025 Eduard Urbach