Minor corrections and README update.

Author: 0nyr

README.md

@@ -1,13 +1,31 @@
-# Ascending Syntaxt Parser LR(1)
+# Ascending Syntax Parser LR(1)
+
+This project is a **specific LR(1) (LALR optimized) Ascending Syntax Parser** for the grammar provided in the subject (see `docs/sujet_tp.pdf`).
 
 > circular imports, templating, template specialisation, state DP, singleton DP, GDB debugging
 
+![make run output example](./img/make_run_example.png)
+
+This program has been tested and built for Linux (tested on Ubuntu 20.04).
+
 ### Useful links
 
 [solve circular imports](https://pvigier.github.io/2018/02/09/dependency-graph.html)
 
 [Use GDB debugger](https://www.bitdegree.org/learn/gdb-debugger)
 
+## Compile and run
+
+To run the main program:
+
+1. `make dirs` inside the root folder of the project.
+2. `make` or `make build`
+3. Run the program directly using `./bin/main <expression>` or use `make run`.
+
+To run the tests:
+
+1. `make build_test` or `make all`
+2. Run the program using `./bin/test` or `make run_test`.
 
 ## Notes
 

doc/Sujet de TP GL.pdf renamed to doc/sujet_tp.pdf

@@ -45,4 +45,5 @@ class Automaton
         void clearVectors();
         ParsingResult isActionAccepted();
         void printCurrentSituation();
+        void printInputExpression(std::string const & inputExpression);
 };

img/make_run_example.png

@@ -55,6 +55,8 @@ void Automaton::init(string const & inputExpression)
 
 void Automaton::lexicalAnalysis(std::string const & inputExpression)
 {
+    printInputExpression(inputExpression);
+
     // create list of symbols with lexer
     Lexer l(inputExpression);
     Symbol * s;
@@ -81,6 +83,20 @@ void Automaton::lexicalAnalysis(std::string const & inputExpression)
     printVector("states", states);
 }
 
+void Automaton::printInputExpression(std::string const & inputExpression)
+{
+    std::string logLine = "";
+    #ifdef COLORS
+    logLine += LIGHT_ORANGE;
+    #endif
+    logLine += "===> Input expression: ";
+    logLine += inputExpression;
+    #ifdef COLORS
+    logLine += NO_COLOR;
+    #endif
+    std::cout << logLine << std::endl;
+}
+
 ParsingResult Automaton::Parsing(std::string const & inputExpression)
 {
     init(inputExpression);