Clean up docs
This commit is contained in:
@@ -4,7 +4,7 @@ The build is a PyInstaller **one-folder** bundle: Python, Qt (incl. Qt Multimedi
|
||||
FLAC, opus, mpg123) and soxr are all inside; nothing else is installed or needed at runtime. Build on each
|
||||
target OS (no cross-compiling).
|
||||
|
||||
## Windows (x86-64) - tested
|
||||
## Windows (x86-64)
|
||||
```
|
||||
py -3.14 -m venv .venv (Python 3.10-3.14)
|
||||
.venv\Scripts\python -m pip install -e .[app,dev]
|
||||
@@ -32,7 +32,7 @@ dist\UnheardCity\UnheardCity.exe --smoke-test --report smoke.txt & type smoke
|
||||
dist\UnheardCity\UnheardCity.exe --quit-after 8 --screenshot shot.png
|
||||
```
|
||||
|
||||
## Linux (x86-64) - procedure (not executed on the development machine)
|
||||
## Linux (x86-64)
|
||||
Use the oldest distribution you want to support (glibc compatibility), e.g. Ubuntu 22.04:
|
||||
```
|
||||
sudo apt install python3 python3-venv libxcb-cursor0 libxkbcommon-x11-0 libegl1 libpulse0
|
||||
@@ -51,5 +51,3 @@ Notes:
|
||||
`libraryfolders.vdf`. The game language is read from the Proton prefix
|
||||
(`steamapps/compatdata/200260/pfx/drive_c/users/steamuser/Documents/WB Games/...`).
|
||||
- The in-game test harness (`ackit verify --ingame`) is Windows-only; everything else is portable.
|
||||
|
||||
A GitHub Actions workflow that builds both platforms is in `.github/workflows/build.yml`.
|
||||
|
||||
@@ -98,9 +98,3 @@ limit but means LZO recompression of large engine packages: out of scope, high r
|
||||
replacement file, decoded off the GUI thread), next to the Apply/Revert buttons while encoding/writing, and in
|
||||
the status bar for game loading and bulk changes.
|
||||
All filter selectors (including Character) are plain, non-editable drop-downs so they look and behave alike.
|
||||
|
||||
## 8. Testing limitations
|
||||
- No Linux machine, WSL distribution or container runtime is available on the development PC. Linux support is
|
||||
covered by portable code (no Windows-only calls outside `ackit/verify`), path handling for Steam/Flatpak/
|
||||
Proton, unit tests that run on any OS, and a documented build procedure; the Linux package could not be
|
||||
executed here.
|
||||
|
||||
Reference in New Issue
Block a user