summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e064336
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# Fyntv — Flexible Yet Novel Transform Vector
+
+```
+fyntv/
+├── doc/ — ISA specification, programmer's manual, ABI docs
+├── isa/ — Formal ISA definition: encoding, opcodes, extensions
+├── gen/ — Code generators (C programs that generate source code)
+│ ├── tablegen/ — Instruction table generation (like LLVM TableGen)
+│ ├── decoder/ — Generate decoder sources from ISA definitions
+│ ├── encoder/ — Generate encoder/assembler sources
+│ ├── disassembler/ — Generate disassembler sources
+│ ├── opcodes/ — Generate opcode header files
+│ ├── abi/ — Generate ABI-related sources
+│ └── docs/ — Generate documentation from machine-readable ISA defs
+├── asm/ — Assembler
+├── disasm/ — Disassembler
+├── tools/ — Full binutils-style toolchain
+│ ├── gas/ — Assembler (GNU style)
+│ ├── ld/ — Linker
+│ ├── objdump/ — Object file dumper
+│ ├── objcopy/ — Object file copy/strip
+│ ├── readelf/ — ELF reader
+│ ├── nm/ — Symbol listing
+│ ├── ar/ — Archive utility
+│ ├── size/ — Section size reporter
+│ ├── strings/ — String extractor
+│ ├── addr2line/ — Address-to-line converter
+│ └── cxxfilt/ — C++ name demangler
+├── sim/ — Instruction-set simulator / emulator
+├── linker/ — Linker scripts & runtime
+├── runtime/ — C runtime (crt0, startup code)
+├── tests/ — Test suites
+│ ├── asm/ — Assembly-level tests
+│ ├── sim/ — Simulator tests
+│ ├── regression/— Regression test suite
+│ └── benchmarks/— Benchmark programs
+├── examples/ — Example programs
+│ ├── asm/ — Assembly examples
+│ ├── c/ — C language examples
+│ └── benchmarks/— Dhrystone, Coremark, etc.
+├── scripts/ — Build scripts, CI, release tooling
+└── docker/ — Docker build environments
+```