WIP Readme

README

 AUTHORS
 -------
 
-- NAME1
-- NAME2
-…
+- Claire Girot--Person
+- Augustin Jaujay
 
 ===============
 
 Description of the project
 --------------------------
 
-This μ-project is a very simple compiler…
+This μ-project is a very simple compiler implemented in OCaml. It can read source files written both in Expr of Pfx. The compiler compiles from Expr to Pfx and executes the Pfx instructions in a small virtual machine.
 
-===============
-
-Sources
--------
-
-Git repository: https://redmine-df.telecom-bretagne.eu/git/PROJECTNAME
+Git repository: http://gitlab.imt-atlantique.fr/a19jauja/compilerlalog
 
-(obviously, you _will_ use a version control system such as Git, IMT
-Atlantique provides a project management platform: use it!)
-
-Release : tag 1.0 or commit acdeacdacdacdacd
+Release : Last commit
 
 ===============
 
@@ -31,15 +22,15 @@ How to…
 
 …retrieve the sources?
 
-  git clone https://redmine-df.telecom-bretagne.eu/git/PROJECTNAME
+  git clone git@gitlab.imt-atlantique.fr:a19jauja/compilerlalog.git
 
 …compile?
 
-  dune …
+  dune build
 
 …execute and test?
 
-  dune exec ./pfxVM.exe -- TESTFILE.pfx
+  dune exec ./pfx/pfxVM.exe -- TESTFILE.pfx
 
 
 ===============
@@ -57,6 +48,7 @@ You may also show the file tree as the following example:
 project
 ├── README
 ├── dune-project
+├── .gitignore
 ├── expr: the expr compiler
 │   ├── README
 │   ├── basic
@@ -80,8 +72,15 @@ project
 │   ├── fun: the expr parser for section 7
 │   │   ├── ast.ml
 │   │   ├── ast.mli
+│   │   ├── dune
+│   │   ├── eval.ml
+│   │   ├── eval.mli
 │   │   ├── lexer.mll
-│   │   └── parser.mly
+│   │   ├── parser.mly
+│   │   ├── tests: for tests
+│   │   │   └── an_example.expr
+│   │   ├── toPfx.ml
+│   │   └── toPfx.mli
 │   └── main.ml
 ├── pfx: the pfx VM
 │   ├── basic
@@ -94,6 +93,7 @@ project
 │   │   ├── parser.mly           <- To edit
 │   │   └── tests: for tests
 │   │       └── ok_prog.pfx
+│   ├── dune
 │   └── pfxVM.ml: main file for the pfx VM
 └── utils
     ├── dune
@@ -104,18 +104,15 @@ project
 Progress
 --------
 
-- We stopped at question 10.1 (proof of derivation)
-- There is still a bug in question 8.3 (new version of generate function)
-- …
+- We stopped at question 10.4.
+- There is still a bug in question 10.3 : we couldnt find how to decrement the index of a variable in the environment.
 
 ===============
 
 Know bugs and issues
 --------------------
 
-- We were not able to manage xxx…
-- Compiler fails when xxx…
-- …
+- This is linked with the bug described earlier
 
 ===============