diff options
Diffstat (limited to 'src/readme.md')
| -rw-r--r-- | src/readme.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/src/readme.md b/src/readme.md new file mode 100644 index 0000000..a8ffc51 --- /dev/null +++ b/src/readme.md @@ -0,0 +1,34 @@ +# engine source + +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. + +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 +(all examples can be built at once by specifying the `examples` target): + +``` +$ 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 +``` + |