aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Herklotz <ymherklotz@gmail.com>2018-03-11 12:35:27 +0000
committerYann Herklotz <ymherklotz@gmail.com>2018-03-11 12:35:27 +0000
commitf696dcf3d4e17f2339b22b233ea370ee6a28d968 (patch)
tree9e61671fedf79274c3abd4c3e2bb7554fe707505
parent6b363132d735df2af03e8d9e183afd443ee123d4 (diff)
downloadMipsCPU-f696dcf3d4e17f2339b22b233ea370ee6a28d968.tar.gz
MipsCPU-f696dcf3d4e17f2339b22b233ea370ee6a28d968.zip
[Doc] Added documentation on buildHEADmaster
-rwxr-xr-xREADME.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index a021da0..e72f6c1 100755
--- a/README.md
+++ b/README.md
@@ -1,2 +1,15 @@
-Mips CPU
-========
+# Mips CPU
+
+MIPS I simulator written in C++.
+
+## Build
+
+To build the cpu, the [`makefile`](/makefile) can be used.
+
+``` shell
+# Building
+make
+
+# Running tests
+./src/ymh15/test_mips
+```