EntityComponentMetaSystem/README.md

39 lines
1.1 KiB
Markdown
Raw Normal View History

2021-09-08 06:08:49 +00:00
# About
2017-06-10 13:15:59 +00:00
2021-09-08 06:08:49 +00:00
EntityComponentMetaSystem is a header-only library. However, UnitTests can be
2024-07-15 04:49:50 +00:00
built and run using cmake (gtest is ~~a dependency~~ no longer a dependency).
2021-09-08 06:08:49 +00:00
2021-09-08 09:06:24 +00:00
# Generated Doxygen Documentation
[Check this repository's gh-pages documentation on ECMS](https://stephen-seo.github.io/EntityComponentMetaSystem/)
2024-01-15 04:56:49 +00:00
[Alternatively, check out the doxygen docs hosted on my website](https://seodisparate.com/ecms_docs/)
2021-09-08 06:08:49 +00:00
# Compiling the UnitTests
2017-06-10 13:15:59 +00:00
Create a build directory.
`mkdir build`
Generate makefile with CMake.
2017-06-10 13:16:55 +00:00
`cd build`
2021-09-08 06:08:49 +00:00
`cmake -DCMAKE_BUILD_TYPE=Debug ../src`
2017-06-10 13:15:59 +00:00
2021-09-08 06:08:49 +00:00
Build the project's UnitTests.
2017-06-10 13:15:59 +00:00
`make`
2021-09-08 06:08:49 +00:00
Run the UnitTests.
`./UnitTests`
# Install the Header-Only Library
`mkdir build; cd build`
`cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ../src`
Install the project to where you want to.
2018-05-21 07:49:37 +00:00
`make DESTDIR=install_here install`
2017-06-10 13:15:59 +00:00
2021-09-08 06:08:49 +00:00
In this example, `CMAKE_INSTALL_PREFIX=/usr`, then invoking
`make DESTDIR=install_here install` will install the `src/EC` directory to
`install_here/usr/include`. The path to `Manager.hpp` will then look like
`install_here/usr/include/EC/Manager.hpp`