MPROMEditor now calls its columns "Opcode" and "muPC"
[Mograsim.git] / README.md
index a20ad72..311ac75 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# About
+# 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. 
@@ -6,18 +6,25 @@ 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
+* 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.  
+16-bit arrangement used by the Technical University of Munich as an example.
+
+**For more information and how to use and install Mograsim, visit https://mograsim.net**
 
 # Getting Started
 
-See [Getting Started](docs/getting_started.md)
+See https://mograsim.net#_getting_started_with_mograsim
 
 # Building Mograsim
 
-See [Building Mograsim](docs/building_mograsim.md)
\ No newline at end of file
+| 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)