Documentation done

Author: vijayphoenix

README.md

@@ -1,22 +1,106 @@
-# Implementing a JIT Compiled Language with Haskell 
+[![CircleCI](https://circleci.com/gh/IITH-SBJoshi/haskell-11/tree/master.svg?style=svg&circle-token=72b4ba1854966fc5f4e58b1e3d0fc5a05cf4ad66)](https://circleci.com/gh/IITH-SBJoshi/haskell-11/tree/master)  
+
+# Implementing a JIT Compiled Language with Haskell   
 
 ## About  
 
+The aim of the project was to implement a simple procedural language.    
+We named it **HASKULL** :-)  
+The frontend is written in Haskell and the backend it managed LLVM-hs-pure package.   
+The project extensively uses Monads, State Monads, Applicative functors and Transformers.  
+
 ### Built With  
 
-### Installing
+You will need GHC 7.8 or newer as well as LLVM 4.0.  
+
+### Installation  
+
+Clone the repository:    
+
+```
+git clone "https://github.com/IITH-SBJoshi/haskell-11.git"
+```
+
+Browse to the directory where all the files of this repository are located.  
+
+Run the following command to build the project.  
+
+```
+stack build 
+```
+# Usage  
+
+Run the following command to get an interactive console.  
+
+```
+stack repl
+```
+Type "main" in the interactive console.  
+
+Write any code using following Syntax rules  
+
+```
+Syntax rules: 
+[A] means optional arg. of type A .
+
+All the symbol starting with lower-case letter are terminal(lexer units).
+All the operators are left associative
+
+Command = Expr ;
+Expr : DeclarationStmt | FuncCallStmt | LiteralStmt | Var | ifthenStmt | (Expr)
+
+DeclarationStmt : ExternDecl | VarDecl
+
+ExternDecl : extern Name([ArgList]) : Type 
+VarDecl    : Type VList 
+
+Type : int | string 
+VList: Name[, VList]
+
+FuncCallStmt : Call 
+Call : Name ( [Args] ) 
+
+BinOpCallStmt : BinOpCall
+BinOpCall : Expr Op Expr 
+
+Op : + | - | * | / | ; | = | <
+reserved keywords: int char def extern string if then else
+Args : Expr[, Args]
+
+LiteralStmt : StrLiteral  | IntLiteral 
+IntLiteral  : integer
+StrLiteral  : string
+
+Name : ident
+ArgList : Type Name[, ArgList]
+
+Func : def Name([ArgList]) : Type { Command-list }
+Command-list = Command [Command-list]
+
+Command = Expr ;
+```
+For more insight on the language grammer, refer to Language.hs, Lexer.hs, Parser.hs files.  
 
-On Linux  
 
 ### Documentation  
 
 This project is documented under [Haddock](https://www.haskell.org/haddock/#Documentation) Documentation  
 
+To generate documentation run:  
+
+```
+stack haddock
+```
+
 ### Authors  
 
-* [**Vijay Tadikamalla**](https://github.com/vijayphoenix)
+* [**Vijay Tadikamalla**](https://github.com/vijayphoenix)  
+* [**Anjani Kumar**](https://github.com/anjani-1)  
+* [**Anupam Saini**](https://github.com/anupamsaini98)  
+* [**Yogesh Singh**](https://github.com/yo5sh)  
 
 #### License  
+* [LICENSE](https://github.com/IITH-SBJoshi/haskell-11/blob/master/LICENSE)  
 
 #### Acknowledgments  
-* [Haskell LLVM JIT Compiler Tutorial](http://www.stephendiehl.com/llvm)
+* [Haskell LLVM JIT Compiler Tutorial](http://www.stephendiehl.com/llvm)