aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohannes Stoelp <johannes.stoelp@gmail.com>2023-11-04 02:08:14 +0100
committerJohannes Stoelp <johannes.stoelp@gmail.com>2023-11-04 02:08:14 +0100
commit090ff4fe2d47dd3b733bd8795a38ac8d444de428 (patch)
treeae5187fafe9343fb47d07df2862da96c0842bd94
parentdcea35a1bfc12d5ff35929971cba5a48638deb85 (diff)
downloadsysc-playground-090ff4fe2d47dd3b733bd8795a38ac8d444de428.tar.gz
sysc-playground-090ff4fe2d47dd3b733bd8795a38ac8d444de428.zip
update readme after systemc cmake integration
-rw-r--r--README.md20
1 files changed, 16 insertions, 4 deletions
diff --git a/README.md b/README.md
index fefa166..c6c7136 100644
--- a/README.md
+++ b/README.md
@@ -3,9 +3,8 @@
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.
+The [Makefile](Makefile) documents how to configure and build the simulations
+as well as run the tests contained in the repository.
```sh
# Build SystemC, all simulations and tests.
@@ -27,8 +26,21 @@ file name (w/o extension) to the `simulations` list in
Happy hacking.
+## SystemC build
+
+The SystemC simulator is automatically built as dependency in cmake. Currently
+two different build scripts are available (mainly because of own experiments).
+- [CMakeLists-sysc-fetch.txt](cmake/CMakeLists-sysc-fetch.txt) use
+ [`FetchContent`][cmake-fetch] to make SystemC available, this will treat
+ SystemC as source dependency and make all build targets available.
+- [CMakeLists-sysc-external.txt](cmake/CMakeLists-sysc-external.txt) use
+ [`ExternalProject`][cmake-external] to make SystemC available, this will
+ treat SystemC as external dependency and therefore needs to provide targets
+ manually.
+
## License
This project is licensed under the [MIT](LICENSE) license.
[sysc-home]: https://www.accellera.org/downloads/standards/systemc
-
+[cmake-fetch]: https://cmake.org/cmake/help/latest/module/FetchContent.html
+[cmake-external]: https://cmake.org/cmake/help/latest/module/ExternalProject.html