Add readme for examples

This commit is contained in:
Joscha 2019-11-10 21:57:11 +00:00
parent a2f723b0ce
commit b0d68ed8d6
2 changed files with 61 additions and 4 deletions

View file

@ -3,7 +3,9 @@
A set of tools and specifications related to the MiMa
(Minimalmaschine).
* [Programs](#programs)
* [Tools](#tools)
* [mima-run](#mima-run)
* [mima-asm](#mima-asm)
* [Specification](#specification)
* [Instructions](#instructions)
* [Registers](#registers)
@ -11,9 +13,11 @@ A set of tools and specifications related to the MiMa
* [Memory dump file format: `.mima`](#memory-dump-file-format-mima)
* [Conventions](#conventions)
## Programs
For example MiMa programs, see the [examples folder](examples/).
### `mima-run`
## Tools
### mima-run
This program can load and run `.mima` files.
@ -36,7 +40,7 @@ Available options:
further actions. Roughly equivalent to -n 0
```
### `mima-asm`
### mima-asm
This program can parse `.mimasm` files and convert them to `.mima`
files. More information and a specification of the `.mimasm` format