Skip to content

Commit

Permalink
Update COMPILING.txt
Browse files Browse the repository at this point in the history
Mention the need to compile models when generating release archives. Resolves #5230.
  • Loading branch information
Webster Sheets authored Jul 23, 2021
1 parent 856f5ac commit 0b82c65
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions COMPILING.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Table of Contents
3.2 C++ source - Doxygen
4 Faster startup
4.1 precompile models
5 Installing Pioneer


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

1. make -C build/ build-data



5 Installing Pioneer
====================

Pioneer is designed to be able to run in "portable mode", where the program
is located next to the data directory and does not use system files.
If you would like to install Pioneer in a system-wide fashion, please refer
to the release steps used in the Github Actions workflow files for details
regarding the commands used on each platform to generate release archives.

If you are creating an installed version of Pioneer, you will need to
ensure that you precompile the model files as described in 4.1 before
running the install step, as installed versions do not package the model
source files and depend on the *.sgm files for efficient loading of assets.

1 comment on commit 0b82c65

@AMDmi3
Copy link
Contributor

@AMDmi3 AMDmi3 commented on 0b82c65 Jul 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Please sign in to comment.