aboutsummaryrefslogtreecommitdiff
path: root/src/readme.md
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-10-10 08:01:27 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-10-10 08:01:27 +0200
commit579824011d5e8776e2079d6624a39535517760ff (patch)
tree7addd40affd1e15b5e6c4ea108847ef6a6eef7ea /src/readme.md
parent44208336d80dd63735215ee2cafb3e73fa03f930 (diff)
update readmes
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
+```