aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: fefa1667c9f0fa15277a6a3a42054e3de35f42a7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# sysc-playground

This repository serves as a playground for [SystemC/TLM2][sysc-home] and allows
to quickly start hacking on SystemC/TLM2 simulations.

The [Makefile](Makefile) documents how to download and build the SystemC
simulator as well as build and run the simulations and tests contained in the
repository.

```sh
# Build SystemC, all simulations and tests.
make build

# Run all tests.
make test

# Run all simulations in src/.
make run

# Run only the lt_bus simulation.
make run/lt_bus
```

New simulations can be added by creating a new file in `src/` and adding the
file name (w/o extension) to the `simulations` list in
[CMakeLists.txt](CMakeLists.txt).

Happy hacking.

## License
This project is licensed under the [MIT](LICENSE) license.

[sysc-home]: https://www.accellera.org/downloads/standards/systemc