aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-11-04 08:28:18 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-11-04 08:28:18 +0100
commit06f65659fc6ffde7cabd2135040cbfbf089e5a24 (patch)
treee3570bea52b87b6919550ee81d17927ccbc11cc5 /readme.md
parent128969619a22dfc17a9ea35335c0d21c6ad0c954 (diff)
parent6aa8fdd04728b6a499f526de727514ae3d0490b4 (diff)
merge `origin/master` into `master`
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md27
1 files changed, 15 insertions, 12 deletions
diff --git a/readme.md b/readme.md
index d095d74..7cf044f 100644
--- a/readme.md
+++ b/readme.md
@@ -19,26 +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
+ $ 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