aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorXavier Del Campo Romero <xavi.dcr@tutanota.com>2022-07-23 04:08:26 +0200
committerXavier Del Campo Romero <xavi.dcr@tutanota.com>2022-07-23 04:23:05 +0200
commit55e2d00c4565b4802e8c6aaa9cd97f6f3a601505 (patch)
treea6b4782b978ba3361535873c04c09978d92c4463 /README.md
parenta091af05c6d5db45162baf2cedf7ecf883953c34 (diff)
README.md: Update documentation for Win9x builds
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 30 insertions, 1 deletions
diff --git a/README.md b/README.md
index cb654fb..b808c01 100644
--- a/README.md
+++ b/README.md
@@ -88,13 +88,42 @@ on real hardware.
```sh
mkdir build
cd build
-cmake .. -DCMAKE_TOOLCHAIN_FILE=../cmake/win9x-toolchain.cmake
+SDLDIR=<sdl-prefix> \
+ SDLMIXERDIR=<sdl_mixer-prefix> \
+ SDLGFXDIR=<sdl_gfx-prefix> \
+ cmake .. -DCMAKE_TOOLCHAIN_FILE=../cmake/win9x-toolchain.cmake
make -j$(nproc --all)
```
+Where:
+
+- `SDLDIR` is the path to the cross-compiled version for `SDL-1.2`, which
+would correspond to `./configure --prefix=$SDLDIR` used when building
+`SDL-1.2`.
+- `SDLMIXERDIR` is the path to the cross-compiled version for `SDL_mixer`,
+which would correspond to `./configure --prefix=$SDLMIXERDIR` used in
+building `SDL_mixer`.
+- `SDLGFXDIR` is the path to the cross-compiled version for `SDL_gfx`,
+which would correspond to `./configure --prefix=$SDLGFXDIR` used in
+building `SDL_gfx`.
+
A stripped version of the executable, as well as game assets, will be
located in `build/cdimg`.
+#### Dependencies
+
+A cross-compiled `i386-mingw32` version of all required dependencies
+is needed before building `rts`.
+
+Note upstream CMake does not provide `FindSDL_gfx.cmake` as of the time
+of this writing, so it is provisionally provided on
+[this repository](cmake/FindSDL_gfx.cmake).
+
+[Ongoing upstream PR](https://gitlab.kitware.com/cmake/cmake/-/merge_requests/7475)
+
+Read [the documentation](doc/BUILD-win9x.md) for further reference on
+how to build the dependencies from source.
+
## License
Unless stated otherwise, **RTS** follows the license described by the