From 52241338370b7b86253189260210c8b746d50193 Mon Sep 17 00:00:00 2001
From: Mylloon <kennel.anri@tutanota.com>
Date: Tue, 6 Dec 2022 20:50:37 +0100
Subject: [PATCH] Add readme

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d51b779
--- /dev/null
+++ 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
+```