]> git.seodisparate.com - EntityComponentMetaSystem/commitdiff
Update README.md
authorStephen Seo <seo.disparate@gmail.com>
Wed, 8 Sep 2021 06:08:49 +0000 (15:08 +0900)
committerStephen Seo <seo.disparate@gmail.com>
Wed, 8 Sep 2021 06:11:56 +0000 (15:11 +0900)
README.md

index 9da128f51d10698c9370445f9a76c7e832d379c8..08f9fbeb75befb34d3ad3b5a8ac86634bca381be 100644 (file)
--- a/README.md
+++ b/README.md
@@ -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.  
 `mkdir build`
 
 Generate makefile with CMake.  
 `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`
 
-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`
 
+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`