diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..fefa166 --- /dev/null +++ b/README.md @@ -0,0 +1,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 + |