Cleaned dff4_finewe

[Mograsim.git] / README.md

diff --git a/README.md b/README.md
index e69de29..f7bf383 100644 (file)
--- a/README.md
+++ b/README.md
@@ -0,0 +1,28 @@
+# About 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
+
+| Branch | Status |
+| ------ | ------ |
+| `master` | ![Java CI](https://github.com/MaisiKoleni/Mograsim/workflows/Java%20CI/badge.svg) |
+| `development` | ![Java CI](https://github.com/MaisiKoleni/Mograsim/workflows/Java%20CI/badge.svg?branch=development) |
+
+See [Building Mograsim](docs/building_mograsim.md)