diff options
| -rw-r--r-- | readme.md | 27 | ||||
| -rw-r--r-- | src/readme.md | 8 |
2 files changed, 18 insertions, 17 deletions
@@ -19,28 +19,29 @@ building instructions. ## Installing libraries The expected library (source) versions are included in this repository as git -submodules. Follow these steps for manually building one of the required -libraries from source: +submodules, which may be used if your distro's package manager does not provide +(recent enough versions of) them. To build any of the dependencies, make sure +the submodules are initialized by running: -1. Ensure the git submodules are initialized: - ``` - $ git submodule update --init --recursive --depth 1 - ``` -2. `cd` into the library source folder: +``` +$ git submodule update --init --recursive --depth 1 +``` + +Then, follow these steps for each library you want to install: + +1. Change into the library folder (run **one** of these): ``` $ cd lib/googletest - or $ cd lib/sdl2 - or $ cd lib/soloud/contrib - or $ cd lib/sdl_image ``` -3. Configure the build, run the build and install: +2. Use CMake to configure the build, run the build and install (run **all** of + these): ``` $ cmake -B build -G Ninja - $ ninja -C build - # ninja -C build install + $ cmake --build build + # cmake --install build ``` ## Documentation diff --git a/src/readme.md b/src/readme.md index a8ffc51..15fa6f3 100644 --- a/src/readme.md +++ b/src/readme.md @@ -8,27 +8,27 @@ Examples (using Ninja): ``` $ cmake -B build -G Ninja -$ ninja -C build +$ cmake --build build ``` Unit tests can be built by explicitly specifying the target `test_main` when running the build command: ``` -$ ninja -C build test_main +$ cmake --build build --target 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 +$ cmake --build build --target audio_internal script ``` For installing crêpe system-wide after building (install must be run with elevated privileges): ``` -# ninja -C build install +# cmake --install build ``` |