summaryrefslogtreecommitdiff
path: root/gen/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'gen/README.md')
-rw-r--r--gen/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/gen/README.md b/gen/README.md
new file mode 100644
index 0000000..958814c
--- /dev/null
+++ b/gen/README.md
@@ -0,0 +1,14 @@
+# Code Generators (C Programs)
+
+Each generator reads the ISA definitions (`../isa/`) and produces C source
+code for the assembler, disassembler, simulator, and documentation.
+
+| Generator | Input | Output |
+|------------------|-------------------|----------------------------------|
+| `tablegen/` | ISA encoding | Instruction decode tables |
+| `decoder/` | Encoding tables | Decode switch/case source |
+| `encoder/` | Opcode tables | Assembler encode logic |
+| `disassembler/` | Opcode tables | Disassembler string formatting |
+| `opcodes/` | Opcode YAML | `opcodes.h`, `opcodes.c` |
+| `abi/` | ABI spec | Calling convention stubs |
+| `docs/` | ISA YAML | RST/Markdown/HTML ISA manual |