From 4e1edee7383af381d51b11fce45b6a15b62f10e7 Mon Sep 17 00:00:00 2001 From: hachem Date: Sun, 13 Sep 2026 00:37:24 +0200 Subject: docs: split docs --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'README.md') 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: -- cgit v1.3