stephenseo/EntityComponentMetaSystem
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Stephen Seo 2021-09-08 15:08:49 +09:00
parent 577a647ca4
commit 388d48056f
1 changed files with 22 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -1,16 +1,34 @@
# About
# Compiling EntityComponentMetaSystem is a header-only library. However, UnitTests can be
built and run using cmake (gtest is a dependency).
[(Note that gtest uses the BSD 3-Clause License.)](https://github.com/google/googletest/blob/master/LICENSE)
# Compiling the UnitTests
Create a build directory. Create a build directory.
`mkdir build` `mkdir build`
Generate makefile with CMake. Generate makefile with CMake.
`cd build` `cd build`
`cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=True ../src` `cmake -DCMAKE_BUILD_TYPE=Debug ../src`
Build the project. Build the project's UnitTests.
`make` `make`
Optionally install the project to where you want to. 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.
`make DESTDIR=install_here install` `make DESTDIR=install_here install`
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`