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