X-Git-Url: https://mograsim.net/gitweb/?a=blobdiff_plain;f=README.md;h=d0ee43724e56e572fb088b9561442cc1923c2794;hb=a4b446ae7906f7f99f9381abb32945213ea91063;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hpb=5606ceefa2c360772194c85ed884e5f8f06f36aa;p=Mograsim.git

diff --git a/README.md b/README.md
index e69de29b..d0ee4372 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,23 @@
+# Mograsim [![Build Status](https://travis-ci.com/Mograsim-Team/Mograsim.svg?branch=master)](https://travis-ci.com/Mograsim-Team/Mograsim)
+
+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 *(in development)*
+* Defining an ISA (Instruction Set) to use in the assembler *(in development)*
+* 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