update readme

README.md

@@ -1,7 +1,37 @@
-Ce dépôt inclut notre compilateur, un cross assembleur et le code VHDL de notre processeur.
         
+Ce dépôt inclut notre compilateur, un cross assembleur et le code VHDL de notre processeur. Il contient
+
+## Fonctionnalités du parser
+Déclaration de variables
+Affectation de variables
+Calculs (addition, soustraction, division, multiplication)
+Fonction main
+Branches (if, else)
+Conditions (!, ||, &&, ==, !=, <, <=, >, >=)
+Boucle while
+printf
+
+
+## Fonctionnalités du compilateur
+Toutes les fonctionnalités du parser sauf les boucles while (par manque de temps).
+
+## Fonctionnalités du processeur
+Affectation, calculs (sauf division), copie, store, load
+Pipeline à 5 étage
+Gestion des aléas si écriture puis lecture dans le même registre
+
+## Tests unitaires
+Nous avons écrit des tests unitaires pour la table des symboles, dans lesquels nous créons une table des symboles, ajoutons des éléments, et vérifions qu’ils sont bien présents après. Nous testons aussi les erreurs retournées par les fonctions.
+
+## Particularités de l’implémentation
+### Tables
+Toutes nos tables sont implémentées sous la forme de tableaux. Nous avons préféré cette approche plutôt que des listes chaînées car nous itérons souvent dessus, ce qui est très lent quand les données sont éparpillées dans la mémoire, comme dans le cas des listes chaînées.
+Ceci implique cependant que nous avons une taille maximum pour nos tables.
+
+### 
+
+## Installation
 Voici les commandes à entrer dans un terminal pour récupérer, compiler et exécuter le projet
-
 ```shell
 # Clone le dépôt git avec les submodules
 git clone --recurse-submodules https://git.etud.insa-toulouse.fr/ysimard/projet_systeme_info.git
@@ -12,4 +42,62 @@ make
 make test_cross_bin.txt
 ```
 
+## Description des dépôts
+
+### Compilateur (compilator-200)
+
+#### Structure
+
+Ce dépôt contient tous les fichiers nécessaires au fonctionnement du parser et du compilateur, ainsi que des tests unitaires pour la table des symboles. Il contient aussi un interpréteur (dossier `interpreter`), fourni par les professeurs, pour vérifier le code assembleur généré.
+
+En plus des fichiers `al.lex` et `as.y` classiques, ce projet contient plusieurs fichiers `C` utilitaires. `asm_instructions` se charge de modifier le tableau d’instruction assembleur et de l’écrire dans un fichier. `symbol_table` s’occupe de modifier et lire la table des symboles. `symbole_table.test.c` execute des tests unitaires sur le fichier précédent. `yacc_util` est un ensemble de fonctions utilitaires pour simplifier la manipulation de la table des symboles et des instructions assembleur, utilisé par `as.y`.
+
+
+#### Compilation et lancement
+
+Un `Makefile`est fourni pour compiler le projet, qui s’utilise comme suit:
+
+Compiler le compilateur
+```shell
+make compilateur
+```
+Compiler les tests unitaires
+```shell
+make test
+```
+Nettoyer le projet
+```shell
+make clean
+```
+
+Une fois compilé, le compilateur s'exécute de la manière suivante (en remplaçant `INPUT_FILE` par le fichier `C` souhaité et `OUTPUT_FILE` par le fichier destination voulu):
+```shell
+./compilateur OUTPUT_FILE < INPUT_FILE
+```
+
+Pour lancer les tests unitaires, exécuter la commande suivante:
+```shell
+./test
+ ```
+
+Pour vérifier l’asembleur à l’aide de l’interpréteur, copier le contenu du fichier de sortie du compilateur dans le fichier `interpreter/input.txt`, compiler l’interpreteur à l’aide de la commande `make`, et executer la commande suivante:
+
+```shell
+./interpreter < input.txt
+```
+
+### Cross-assembleur (crossassembler-2000)
+Le cross-assembleur a été écrit en majorité par Paul Faure. Nous l’avons simplement adapté pour notre compilateur et notre processeur.
+Il est optimisé car il ne génère par un LOAD et un STORE pour chaque instruction. Il se souvient de quelle donnée est présente dans quel registre.
+
+#### Compilation et lancement
+Compiler
+```shell
+make
+```
+Nettoyer le projet
+```shell
+make clean
+```
+