summaryrefslogtreecommitdiff
path: root/doc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/README.md')
-rw-r--r--doc/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..ba08550
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,12 @@
+# Documentation
+
+| Directory | Contents |
+|----------------|-----------------------------------------------|
+| `spec/` | Formal ISA specification reference manual |
+| `manual/` | Programmer's guide — assembly, toolchain use |
+| `abi/` | Application Binary Interface specification |
+| `internals/` | Microarchitecture, pipeline, implementor notes|
+| `examples/` | Annotated code examples in asm/C |
+
+The `gen/docs/` generator produces source files for these docs from the
+machine-readable ISA definitions.