Add readme

2022-12-06 20:50:37 +01:00 · 2022-12-06 20:50:37 +01:00 · 5224133837
commit 5224133837
parent 697b36c333
1 changed files with 24 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,24 @@
+# Compilateur vers du MIPS en OCaml
+
+## Usage
+
+### Compilation
+
+```
+$ make
+```
+
+### Utilisation
+
+```
+$ ./main.byte {fichier source} > sortie.s
+```
+
+> Une fois le fichier assembleur créé, il est possible d'utiliser
+> [spim](https://sourceforge.net/projects/spimsimulator/) : `spim -file sortie.s`
+
+### Lance les tests
+
+```
+$ make test
+```