README.md

   1 # About Mograsim
   2
   3 Mograsim is a modular, graphical simulator for teaching microprogramming, ISAs and
   4 circuit logic in a way that allows for a smooth transition between those levels.
   5
   6 The aim is to give students a better understanding how these layers blend in a machine,
   7 and what the purpose of microprogramming is. In more detail, Mograsim allows:
   8
   9 * Programming and running simple assembler on the machine *(in development)*
  10 * Defining an ISA (Instruction Set) to use in the assembler *(in development)*
  11 * Microprogram the CPU to implement the specified ISA
  12 * View the Circuit Logic operating and executing the microprogram in detail
  13
  14 Mograsim focuses especially on the AMD Am2900 Family microprocessors in a specific
  15 16-bit arrangement used by the Technical University of Munich as an example.
  16
  17 # Getting Started
  18
  19 See [Getting Started](docs/getting_started.md)
  20
  21 # Building Mograsim
  22
  23 | Branch | Status |
  24 | ------ | ------ |
  25 | `master` | ![Java CI](https://github.com/MaisiKoleni/Mograsim/workflows/Java%20CI/badge.svg) |
  26 | `development` | ![Java CI](https://github.com/MaisiKoleni/Mograsim/workflows/Java%20CI/badge.svg?branch=development) |
  27
  28 See [Building Mograsim](docs/building_mograsim.md)