X-Git-Url: https://mograsim.net/gitweb/?a=blobdiff_plain;f=README.md;h=a20ad72be71b554cee05bd203ae0edbf8fe00178;hb=01cf11d3e0b6127d612a101e0bdd393f3740a02f;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hpb=002110424653b282ab9c7ea4b12f967d59e5f66a;p=Mograsim.git

diff --git a/README.md b/README.md
index e69de29b..a20ad72b 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,23 @@
+# About
+
+Mograsim is a modular, graphical simulator for teaching microprogramming, ISAs and 
+circuit logic in a way that allows for a smooth transition between those levels. 
+
+The aim is to give students a better understanding how these layers blend in a machine, 
+and what the purpose of microprogramming is. In more detail, Mograsim allows:
+
+* Programming and running simple assembler on the machine
+* Defining an ISA (Instruction Set) to use in the assembler
+* Microprogram the CPU to implement the specified ISA
+* View the Circuit Logic operating and executing the microprogram in detail
+
+Mograsim focuses especially on the AMD Am2900 Family microprocessors in a specific 
+16-bit arrangement used by the Technical University of Munich as an example.  
+
+# Getting Started
+
+See [Getting Started](docs/getting_started.md)
+
+# Building Mograsim
+
+See [Building Mograsim](docs/building_mograsim.md)
\ No newline at end of file