aboutsummaryrefslogtreecommitdiff
path: root/src/readme.md
diff options
context:
space:
mode:
authorjaroWMR <jarorutjes07@gmail.com>2024-10-20 13:07:02 +0200
committerjaroWMR <jarorutjes07@gmail.com>2024-10-20 13:07:02 +0200
commit4ff1159fe5f6ee6dd8becc662bc95a93acda545a (patch)
tree670caa42ad4ffbf007a6d7cba683f4f84af87592 /src/readme.md
parent0f03cdbf23f57116b7664a7c98c4605fd69bb961 (diff)
parent77555730e3ddb811b9ce8470659663e3f1573de2 (diff)
Merge branch 'master' of github.com:lonkaars/crepe into jaro/poc-physics
Diffstat (limited to 'src/readme.md')
-rw-r--r--src/readme.md31
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
+```