summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 41e8693..961c979 100644
--- a/README.md
+++ b/README.md
@@ -22,3 +22,14 @@
* doc/CHiLL.pdf
* Doxygen: `cmake --build build -- doc`
+## Folder structure
+
+* `src` - CHiLL's "core" source files
+* `include` - CHiLL's include files
+* `lib` - Included modules, each as its own `src` and `include`
+ * `omega` - omega, LICENSE.omega
+ * `codegen` - codegen+, without rose dependence, LICENSE.omega
+ * `rosecg` - codegen with rose, LICENSE.omega
+ * `parserel` - parse Relation vectors, for adding knowns
+* `example` - CHiLL example scripts
+* `doc` - manual & doxygen