README.md 982 Bytes
Newer Older
Evgeny Kusmenko's avatar
Evgeny Kusmenko committed
1

Jean Meurice's avatar
Jean Meurice committed
2
3
4
5
6

# Basic Simulator

This project is a minimal setup running the MontiSim simulator in a local self-contained jar.

Jean Meurice's avatar
Doc WIP    
Jean Meurice committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
### Quickstart

If you know about MontiSim and Maven, the following will suffice you:

> ```
> git clone https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/basic-simulator
> cd basic-simulator
> mvn clean install -s settings.xml
> ```
> The resulting jar (`target/basic-simulator-1.*.jar`) can be launched normally in any folder and will create
> the required sub-folders and export the needed libraries.

> The `build_install` script build the project and puts the jar in the `install` folder, which contains a sample setup.

If not, the following documents aim at giving an introduction to project building, Maven, scripts and MontiSim.

Jean Meurice's avatar
Jean Meurice committed
23
24
25
26
27
28
29
30
### Documentation Contents

- [Installing and using the Basic Simulator](docs/usage.md)
- [Maven Project tutorial](docs/maven.md)
- [Scripts tutorial](docs/scripts.md)
- [MontiSim overview](docs/montisim.md)

---