docs: add DESIGN.md engineering notes and link from README
Captures the why behind the build: the read-only /app core tension, the packaging architecture (no flatpak-builder/bwrap, Sdk-not-Platform, OSTree on pages), the full read-only-/app saga (X11, Python sdist hook, wrapper venv bootstrap, SNAP/SNAP_BUILD engine path, the unrelocatable user folder, the icon), the CI flow, and a maintenance/debugging guide for future O3DE releases. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -57,6 +57,13 @@ it (`ar` + `tar`) and copies the payload into the Flatpak's `/app`. The version
|
||||
directory inside the `.deb` changes every release, so the wrapper discovers the
|
||||
executable at runtime rather than hard-coding a path.
|
||||
|
||||
> **Want the full story?** O3DE is an engine + SDK that compiles code and writes
|
||||
> into its own install tree at runtime, while a Flatpak gives it a **read-only
|
||||
> `/app`**. Reconciling those two facts is most of the work here.
|
||||
> **[`docs/DESIGN.md`](docs/DESIGN.md)** documents every non-obvious decision, the
|
||||
> read-only-`/app` problems and their fixes, and how to debug/maintain this across
|
||||
> O3DE releases. Read it before changing the build.
|
||||
|
||||
---
|
||||
|
||||
## CI requirements (Gitea Actions)
|
||||
|
||||
Reference in New Issue
Block a user