diff options
| -rw-r--r-- | LICENSE | 21 | ||||
| -rw-r--r-- | README.md | 34 |
2 files changed, 55 insertions, 0 deletions
@@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Johannes Stölp + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. 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 + |