diff options
author | max-001 <maxsmits21@kpnmail.nl> | 2024-10-16 08:35:17 +0200 |
---|---|---|
committer | max-001 <maxsmits21@kpnmail.nl> | 2024-10-16 08:35:17 +0200 |
commit | 5b158d9705f9e912f938f22f2389d6f1dc783b2a (patch) | |
tree | 7addd40affd1e15b5e6c4ea108847ef6a6eef7ea /src/readme.md | |
parent | 2f644ac353f65cd182be13549e32e9b9409f7aad (diff) | |
parent | 579824011d5e8776e2079d6624a39535517760ff (diff) |
Merge remote-tracking branch 'origin/master' into max/POC-ECS-homemade
Diffstat (limited to 'src/readme.md')
-rw-r--r-- | src/readme.md | 31 |
1 files changed, 28 insertions, 3 deletions
diff --git a/src/readme.md b/src/readme.md index 1c5d3a2..a4a71e7 100644 --- a/src/readme.md +++ b/src/readme.md @@ -2,7 +2,32 @@ This folder contains the crêpe engine source files, unit tests, and some toy examples. The only target built by default by the CMakeLists.txt in this folder -is the crêpe shared library object. Unit tests can be built by explicitly -specifying the target `test_main` when running the build command. Each source -file in the example/ folder corresponds to a CMake target as well. +is the crêpe shared library object. + +Examples (using Ninja): + +``` +$ cmake -B build -G Ninja +$ ninja -C build +``` + +Unit tests can be built by explicitly specifying the target `test_main` when +running the build command: + +``` +$ ninja -C build test_main +``` + +Each source file in the example/ folder corresponds to a CMake target as well: + +``` +$ ninja -C build audio_internal components_internal +``` + +For installing crêpe system-wide after building (install must be run with +elevated privileges): + +``` +# ninja -C build install +``` |