Skip to content

Commit 0b82c65

Browse files
author
Webster Sheets
authored
Update COMPILING.txt
Mention the need to compile models when generating release archives. Resolves #5230.
1 parent 856f5ac commit 0b82c65

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

COMPILING.txt

+17
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Table of Contents
1717
3.2 C++ source - Doxygen
1818
4 Faster startup
1919
4.1 precompile models
20+
5 Installing Pioneer
2021

2122

2223
1 How to compile Pioneer
@@ -266,3 +267,19 @@ models into *.sgm files. This uses the modelcompiler, invoked through CMake.
266267
From the pioneer root directory the following will batch compile all models:
267268

268269
1. make -C build/ build-data
270+
271+
272+
273+
5 Installing Pioneer
274+
====================
275+
276+
Pioneer is designed to be able to run in "portable mode", where the program
277+
is located next to the data directory and does not use system files.
278+
If you would like to install Pioneer in a system-wide fashion, please refer
279+
to the release steps used in the Github Actions workflow files for details
280+
regarding the commands used on each platform to generate release archives.
281+
282+
If you are creating an installed version of Pioneer, you will need to
283+
ensure that you precompile the model files as described in 4.1 before
284+
running the install step, as installed versions do not package the model
285+
source files and depend on the *.sgm files for efficient loading of assets.

0 commit comments

Comments
 (0)