Create README.md

fauzanzaid · May 4, 2018 · 45ce952 · 45ce952
1 parent 119fef1
commit 45ce952
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+# Symbol-Table-in-C
+An implementaton of static scoped symbol tables for semantic analysis in C
+
+### Building
+First, download the dependencies:
+```bash
+./download_dependencies.sh
+```
+
+Then, to build the static library, run the following commands from the terminal:
+```bash
+mkdir build ; cd build && cmake .. && make ; cd ..
+```
+This will build ```libSymbolEnv.a``` in ```./lib``` directory.
+
+### Usage
+See ```include/SymbolEnv.h``` for information about functionality provided by this module