Browse Source

Add documentation for LINUX_PORTABLE variable

Package maintainers need to be aware of this,
and it is difficult to find.
manifold 2 years ago
parent
commit
86ae5b4de6
1 changed files with 4 additions and 0 deletions
  1. 4 0
      README.md

+ 4 - 0
README.md

@@ -37,6 +37,10 @@ Each build produces installers and packages that you can use for testing and rel
 
 Simply create and push a tag and GitHub Actions will run the pipeline in Release Mode. This mode uses the tag as its version number instead of the git ref in normal mode.
 
+### Packaging on Linux
+
+The install step results in different directory structures depending on the value of `LINUX_PORTABLE` - "OFF" will organize outputs to be placed in the system root, such as `/usr/`, and "ON" will organize outputs for portable installations in the user's home directory. If you are packaging for a Linux distribution, you probably want to set `-DLINUX_PORTABLE=OFF`.
+
 ### Signing and Notarizing on macOS
 
 On macOS, Release Mode builds can be signed and sent to Apple for notarization if the necessary codesigning credentials are added as secrets to your repository. **You'll need a paid Apple Developer Account for this.**