From 579824011d5e8776e2079d6624a39535517760ff Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Thu, 10 Oct 2024 08:01:27 +0200
Subject: update readmes

---
 readme.md | 37 ++++++++++++++++++++++++++++++++-----
 1 file changed, 32 insertions(+), 5 deletions(-)

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
index 5351dfe..24bb66f 100644
--- a/readme.md
+++ b/readme.md
@@ -8,18 +8,45 @@ This repository contains:
 |`mwe/`|minimal working examples and proof-of-concepts|
 |`src/crepe/`|game engine source code|
 |`src/test/`|unit tests|
-|`src/example`|standalone examples using game engine|
+|`src/example/`|standalone examples using game engine|
 
 ## Compilation
 
 This repository uses CMake (the makefile in the root of this repository is for
-running auxiliary tasks only). Make sure you have initialized and updated the
-submodules before compiling.
+running auxiliary tasks only). See [src/readme.md](src/readme.md) for detailed
+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:
+
+1. Ensure the git submodules are initialized:
+   ```
+   $ git submodule update --init --recursive --depth 1
+   ```
+2. `cd` into the library source folder:
+   ```
+   $ cd lib/googletest
+   or
+   $ cd lib/sdl2
+   or
+   $ cd lib/soloud/contrib
+   ```
+3. Configure the build, run the build and install:
+   ```
+   $ cmake -B build -G Ninja
+   $ ninja -C build
+   # ninja -C build install
+   ```
 
 ## Documentation
 
-API documentation is done using Doxygen. To generate the docs, run `make
-doxygen`.
+API documentation is done using Doxygen. To generate the docs, run
+```
+$ make doxygen
+```
 
 ## Code style
 
-- 
cgit v1.2.3