updating documentation

[proglang.git] / documentation

diff --git a/documentation b/documentation
index c3ac4e08ba815c574432d3e2f0905cf120a460e1..47008eefba987fb88613cf46094072b64c289764 100644 (file)
--- a/documentation
+++ b/documentation
@@ -1,7 +1,18 @@
 ####### DOCUMENTATIATOIAITAT ION ########
 
+Usage:
+
+./CompInt [-c] [file]
+
+-c : Compile [file], interprets if it isn't specified
+
+if no arguments are specified then the file is interpreted
 
 Files:
+Interpret.hs: Handles the interpretation of a program
+
+Compile.hs: Compiles the program into a c program
+
 Typechecker.hs: Simple modification of the bnfc-generated Testsyntax which calls the type-checking functions.
 
 Typecheck.hs: Contains the type-checking functions typeCheckExp, typeCheckVar and typeCheckStm and some utility functions, responsible for the entire type-checking process.
@@ -9,7 +20,7 @@ Typecheck.hs: Contains the type-checking functions typeCheckExp, typeCheckVar an
 Abssyntax.hs, Parsyntax.y, Lexsyntax.x,ErrM.hs,Printsyntax.hs,Skelsyntax.hs: The files generated by bnfc, only modification is the removal of the Bool type in Abssyntx.hs so haskell's internal type can be used.
 
 
-typing rules
+semantic rules
 ++++++++++++