From 16fd07d6a8cc2e91b8305b2d2769379398c9c045 Mon Sep 17 00:00:00 2001
From: Loic GUEGAN <loic.guegan@yahoo.fr>
Date: Fri, 31 Aug 2018 18:53:05 +0200
Subject: [PATCH] Add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e3432e7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# MicSim
+
+Hi! Welcome to MicSim project repo. MicSim is a Mic-1 architecture simulator written in python. It is specially design for studying purpose. 
+
+### How it works ?
+It is simple, you have to:
+ 1. Clone the repo
+ 2. Execute micsim.py
+ 3. Enjoy !
+
+### I want to know more about it....
+All the architecture components are located in _components_ folder:
+ - **ijvm.py** Contains standard IJVM constant
+ - **microprogram.py** Contains IJVM implementation that use Mic-1 architecture
+ - **caretaker.py** Hold all the Mic-1 architecture components (registers, ram etc..)
+ - **ram.py** Contains a simple RAM implementation