aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-03-21 21:57:13 -0400
committerBruce Hill <bruce@bruce-hill.com>2025-03-21 21:57:13 -0400
commit01f92218930e30ea5e4bca9e30ecadf27e6e9882 (patch)
tree1f0062e63c1665ce71511e4f6eb06460cd30a867 /src
parentfee1723e8b6610aa27baeab4a2dfd769532a54d3 (diff)
Add src/README.md
Diffstat (limited to 'src')
-rw-r--r--src/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/src/README.md b/src/README.md
new file mode 100644
index 00000000..9ea5db9d
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1,15 @@
+# Source Files
+
+This directory contains the source files for the Tomo compiler:
+
+- Abstract syntax trees: [ast.c](ast.c)/[ast.h](ast.h)
+- Compilation: [compile.c](compile.c)/[compile.h](compile.h)
+- Helper functions for Cords: [cordhelpers.c](cordhelpers.c)/[cordhelpers.h](cordhelpers.h)
+- Compilation logic for enums: [enums.c](enums.c)/[enums.h](enums.h)
+- Compilation environments: [environment.c](environment.c)/[environment.h](environment.h)
+- Parsing: [parse.c](parse.c)/[parse.h](parse.h)
+- A read-evaluate-print loop: [repl.c](repl.c)/[repl.h](repl.h)
+- Compilation logic for structs: [structs.c](structs.c)/[structs.h](structs.h)
+- The compiler executable: [tomo.c](tomo.c)/[tomo.h](tomo.h)
+- Typechecking logic: [typecheck.c](typecheck.c)/[typecheck.h](typecheck.h)
+- The datatype for representing Tomo types: [types.c](types.c)/[types.h](types.h)