aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhachem <im@hachem.wtf>2026-09-13 00:37:24 +0200
committerhachem <im@hachem.wtf>2026-09-13 00:37:24 +0200
commit4e1edee7383af381d51b11fce45b6a15b62f10e7 (patch)
tree790c0af3701a732d191891c489b2644dc6d45003 /README.md
parentd50af2e474281a1e88d191f783c2792824698974 (diff)
docs: split docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 299b904..35119c8 100644
--- a/README.md
+++ b/README.md
@@ -34,7 +34,12 @@ proc main
The program still directly controls the registers used for the system calls. Nothing is hiding what the program is doing. More examples can be found in [examples/](examples/).
## Documentation
-The full language reference, shit like directives, declarations, statements, expressions, registers and extensions, is explained in [docs/language.md](docs/language.md).
+The docs live in [docs/](docs/):
+
+- [Getting started](docs/getting-started.md) — build the compiler, write and run a first program on x86-64 and AArch64.
+- [Language reference](docs/language.md) — directives, declarations, statements, control flow, memory, floats, raw instructions and extensions.
+- [Targets](docs/targets.md) — architectures and assemblers, what each supports, and the per-architecture syscall ABIs.
+- [Internals](docs/internals.md) — the compiler pipeline and how to add a backend or architecture.
## Building
The build is driven by [Meson](https://mesonbuild.com/). Configure a build directory and compile the compiler: