summaryrefslogtreecommitdiff
path: root/common/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'common/README.md')
-rw-r--r--common/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/common/README.md b/common/README.md
new file mode 100644
index 00000000..d6a5dbb8
--- /dev/null
+++ b/common/README.md
@@ -0,0 +1,7 @@
+# Common Utilities
+
+In this module certain common utilities are defined that
+will be reused throughout the project.
+
+* Lexer - the lexer is based upon the one in Ecstasy Programming Language. Its feature rich enough that we do not
+ expect to have to modify it much. \ No newline at end of file