From 45ce952c595caab8db0d84702d78459b349630ba Mon Sep 17 00:00:00 2001
From: Fauzan Zaid <fauzanzaid.dev@gmail.com>
Date: Fri, 4 May 2018 21:03:29 +0530
Subject: [PATCH] Create README.md

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..17bd777
--- /dev/null
+++ 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