From e89a3771717a8043f5718aebd05bdba4138b898b Mon Sep 17 00:00:00 2001 From: Eduard Urbach Date: Sat, 5 Jul 2025 23:41:45 +0200 Subject: [PATCH] Updated documentation --- docs/logo.svg | 9 +++------ docs/readme.md | 35 +++++++++++++++++++---------------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/logo.svg b/docs/logo.svg index 5293098..be81a81 100644 --- a/docs/logo.svg +++ b/docs/logo.svg @@ -1,7 +1,4 @@ - - - - - - fast compilationhigh performancetiny executables + + + \ No newline at end of file diff --git a/docs/readme.md b/docs/readme.md index f460371..a0da0fb 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,11 +1,21 @@ -

q logo

+
+ q logo +

The Q Programming Language

+
> [!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 \ No newline at end of file