summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2016-09-19 18:31:43 -0600
committerTuowen Zhao <ztuowen@gmail.com>2016-09-19 18:31:43 -0600
commitb829868dfd6cbe9da07227220856b975f33e2037 (patch)
tree2a0c0c2fc210f0a16aa9125669abb361a41658e9
parentcc24d207ef280b642a12a53b05a0c11102bfdbb8 (diff)
downloadchill-b829868dfd6cbe9da07227220856b975f33e2037.tar.gz
chill-b829868dfd6cbe9da07227220856b975f33e2037.tar.bz2
chill-b829868dfd6cbe9da07227220856b975f33e2037.zip
add folder descriptions
-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