Add installation instructions

This commit is contained in:
Joscha 2019-11-26 09:54:45 +00:00
parent 7c75f1868a
commit 616a991e21

View file

@ -6,6 +6,7 @@ A set of tools and specifications related to the MiMa
* [Tools](#tools) * [Tools](#tools)
* [mima-run](#mima-run) * [mima-run](#mima-run)
* [mima-asm](#mima-asm) * [mima-asm](#mima-asm)
* [Install](#install)
* [Specification](#specification) * [Specification](#specification)
* [Instructions](#instructions) * [Instructions](#instructions)
* [Registers](#registers) * [Registers](#registers)
@ -40,6 +41,16 @@ files. It can also generate the corresponding `.mima-flags` and `.mima-symbols`
Basic usage: `mima-asm <.mimasm file> [-o <.mima file>]` Basic usage: `mima-asm <.mimasm file> [-o <.mima file>]`
## Install
This project uses [stack](https://haskellstack.org). Make sure you have at least
stack version `2.1`.
To install this project:
1. Clone the repository
2. `cd` into the working directory
3. Run `stack install`
## Specification ## Specification
In the following sections, `<a>` means "the value at the address In the following sections, `<a>` means "the value at the address