Fix incorrect container paths in docs #1206
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fix an erroneous path in the README documentation for building using the Sniper runtime container.
By installing Docker and all the dependencies using a clean Pop!_OS 22.04 LTS Linux distro, and then following the neo README build instructions for Docker, the CMake setup fails at the
cmake --preset linux-debugcommand.I'm assuming this is because our docs instruct to mount the container into
neo/src. But doing so, the relative (unmounted)neo/gamecontent will only contain whatever data got pulled fromneoAssetsrepo by the CMakeLists, and not the game assets still found in the main repo'sneo/gamedir.I've modified the instructions to instead mount to the base repo folder, such that from
neo/src, a relative../gamein the CMake file will reach the code reponeo/gamefiles, even inside the container. I only tested this with Docker, but I assume the same logic would apply for the other container tools listed (Podman, Toolbx), so I edited their paths the same way in the docs.(An alternative solution might be to move all (build-pertinent) data like
GameMenu.res.intoneoAssets? So that we didn't need to mount the fluff in the repo root dir inside the build container just for the sake of thesrc/../gamerelative path traversal.)I also removed the explicit
/neosuffix from thePATH_TO_REPOplaceholder value in the docs, because it already is a part the repo path (and repos can be renamed when forking, so the/neosuffix may be inaccurate for users who renamed their repo fork to something else.The CMake error looks like this (unrelevant lines omitted):
The offending lines being:
neo/src/cmake/build_info.cmake
Lines 27 to 28 in 8c50153
Probably because:
Note the absense of
GameMenu.res.inin thelsprintout. Whereas the KillfeedIcons have indeed been correctly pulled fromneoAssets/neo/resource, into the otherwise nonexistant folder.Here's a more detailed fail output:
Toolchain