cli/q
1
0
Fork 0
Code Issues Pull requests Releases Activity Actions

Updated documentation
All checks were successful
/ test (push) Successful in 17s
Details

Browse source
This commit is contained in:
Eduard Urbach 2025-07-05 23:41:45 +02:00
parent e9364f5801
commit e89a377171
Signed by: akyoto
GPG key ID: 49226B848C78F6C8
2 changed files with 22 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/logo.svg
View file

@ -1,7 +1,4 @@
<svg xmlns="http://www.w3.org/2000/svg" width="830" height="210">
<g aria-label="q" font-size="72" font-weight="400" style="line-height:1;font-variant-ligatures:normal;text-align:center" text-anchor="middle">
<path fill="#fcfcfc" d="M334.5 27.6a70.6 70.6 0 1 0 .2 141.2 70.6 70.6 0 0 0-.2-141.2zm0 115.5c-25 0-45-20-45-44.8a45.1 45.1 0 1 1 45 44.8z" class="c1"/>
<path fill="#b8db9f" d="M380.4 169.7c0-7 5.8-12.6 12.7-12.6 7 0 12.8 5.5 12.8 12.6 0 7-5.7 12.7-12.8 12.7-7 0-12.7-5.8-12.7-12.7z" class="c3"/>
</g>
<text xml:space="preserve" x="437.6" y="69.2" fill="#fff" font-family="system-ui" font-size="16" font-weight="400" style="font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:start"><tspan x="437.6" y="69.2">fast compilation</tspan><tspan x="437.6" y="109.2">high performance</tspan><tspan x="437.6" y="149.2">tiny executables</tspan></text>
<svg xmlns="http://www.w3.org/2000/svg" width="256" height="256">
<path fill="#b8db9f" d="M173.45 192.7c0-7 5.8-12.6 12.7-12.6 7 0 12.8 5.5 12.8 12.6a12.74 12.74 0 0 1-25.5 0z"/>
<path fill="#fcfcfc" d="M127.55 50.6a70.6 70.6 0 1 0 .2 141.2 70.6 70.6 0 0 0-.2-141.2zm0 115.5c-25 0-45-20-45-44.8a45.1 45.1 0 1 1 45 44.8z"/>
</svg>
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 939 B

After

Width:  |  Height:  |  Size: 331 B

Before After
Before After

35
docs/readme.md
View file

@ -1,11 +1,21 @@
<p align="center"><img alt="q logo" src="logo.svg"></p>
<div align="center">
<img src="logo.svg" width="128" alt="q logo">
<h1>The Q Programming Language</h1>
</div>
> [!NOTE]
> `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.
## ⚡️ Installation
## Features
* High performance (`ssa` and `asm` optimizations)
* Tiny executables ("Hello World" is ~500 bytes)
* Fast compilation (5-10x faster than most)
* No dependencies (no llvm, no libc)
## Installation
```shell
git clone https://git.urbach.dev/cli/q
@ -13,26 +23,19 @@ cd q
go build
```
To symlink the compiler as `q`:
## Usage
```shell
ln -s $PWD/q ~/.local/bin/q
q run examples/hello
```
## 🚀 Usage
```shell
q build examples/hello
./examples/hello/hello
```
## 🚦 Tests
## Tests
```shell
go run gotest.tools/gotestsum@latest
```
## 💻 Platforms
## Platforms
| | arm64 | x86-64 |
| ------- | ------ | ------ |
@ -42,7 +45,7 @@ go run gotest.tools/gotestsum@latest
Those marked with a star are supported in theory but there are no developer machines to test them.
## 🔑 Security
## Security
### PIE
@ -57,10 +60,10 @@ Code and data are separated into different memory pages and loaded with differen
| Code | ✔️ | ✔️ | ❌ |
| Data | ✔️ | ❌ | ❌ |
## 🧾 License
## License
Please see the [license documentation](https://urbach.dev/license).
## 🧔 Copyright
## Copyright
© 2025 Eduard Urbach