📝 Add small getting started section

This commit is contained in:
Florian Zaruba 2017-06-04 13:00:33 +02:00
parent f4733307f4
commit ccd0188670

View file

@ -7,6 +7,28 @@
For detailed documentation refer to the [online documentation](http://www.be4web.net/ariane/) (Login: `zarubaf` Password: `zaruba`).
## Getting Started
Checkout the repository and initialize all submodules
```
git checkout git@iis-git.ee.ethz.ch:floce/ariane.git
git submodule update --init --recursive
```
Build Ariane by using the Makefile:
```
make build
```
Start the simulation using Modelsim:
```
make sim
```
Or start any of the unit tests by:
```
make dcache_arbiter
```
# Contributing
Check out the [contribution guide](CONTRIBUTING.md)