aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLoic GUEGAN <loic.guegan@yahoo.fr>2018-08-31 18:53:05 +0200
committerLoic GUEGAN <loic.guegan@yahoo.fr>2018-08-31 18:53:05 +0200
commit16fd07d6a8cc2e91b8305b2d2769379398c9c045 (patch)
tree040545d65855336958596be6b221455bb6ddf373 /README.md
parent27268a12532a3f332bb06ff71c947e15755734c8 (diff)
Add readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
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