Update readme

README.md

@@ -1,3 +1,6 @@
+# Projet Système Info
+### Yohan SIMARD - Arnaud VERGNET
+4IR A1 2020-2021
 
 Ce dépôt inclut notre compilateur, un cross assembleur et le code VHDL de notre processeur.
 
@@ -20,18 +23,8 @@ Toutes les fonctionnalités du parser sauf les boucles while (par manque de temp
 - 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
+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
@@ -57,22 +50,22 @@ En plus des fichiers `al.lex` et `as.y` classiques, ce projet contient plusieurs
 
 Un `Makefile` est fourni pour compiler le projet, qui s’utilise comme suit:
 
-Compiler le compilateur
+- Compiler le compilateur
 ```shell
 make compilateur
 ```
-Compiler les tests unitaires
+- Compiler les tests unitaires
 ```shell
 make test
 ```
-Nettoyer le projet
+- 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
+./compilateur [OUTPUT_FILE] < INPUT_FILE
 ```
 
 Pour lancer les tests unitaires, exécuter la commande suivante:
@@ -80,11 +73,21 @@ Pour lancer les tests unitaires, exécuter la commande suivante:
 ./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:
+Pour vérifier le code assembleur à l’aide de l’interpréteur, copier le contenu du fichier de sortie du compilateur dans le fichier `interpreter/input.txt`, compiler l'interpréteur à l’aide de la commande `make`, et exécuter la commande suivante:
 
 ```shell
 ./interpreter < input.txt
 ```
+#### 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 un nombre d’instructions et un nombre de symboles maximum.
+
+##### Tests unitaires
+Nous avons écrit des tests unitaires pour la table des symboles. Dans ces tests, 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.
+
+##### Fonctions utilitaires
+Pour éviter d’avoir un fichier yacc trop imposant, nous avons créé un fichier `yacc_util.c` qui contient toutes les fonctions qui écrivent des instructions dans la table des instructions.
 
 ### 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.
@@ -100,4 +103,7 @@ Nettoyer le projet
 make clean
 ```
 
+### Processeur (processor-2000)
+#### Simulation et tests
+Ouvrir le projet dans ISE et lancer la simulation. Le fichier `config_simu.wcfg` contient une configuration du simulateur qui permet de visualiser tous les signaux intéressants.