summaryrefslogtreecommitdiff
path: root/top/README
diff options
context:
space:
mode:
Diffstat (limited to 'top/README')
-rw-r--r--top/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/top/README b/top/README
new file mode 100644
index 0000000..6657292
--- /dev/null
+++ b/top/README
@@ -0,0 +1,12 @@
+This directory contains the top level of the compiler.
+Files found here:
+
+phases - the top level calls to the compiler phases; compilation init code
+errors - general error handlers
+globals - global variable definitions
+core-symbols - defines core symbols
+system-init - code to run once after the compiler is loaded.
+driver - top level functions which drive the compiler. There are called
+ from the command interface or directly from the user.
+
+