zwitschi/gig-line
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: bring every document in line with the current build

Browse Source 
README rewritten around the actual state (walkable DemoMap, blockout facades,
planned patches); Tools/README now lists all seventeen tools by role; build.md
gains the content pipeline table and the two enforced rules (one unit conversion,
collision decided at import). Setup gains a content-pipeline row, the toolchain
state notes the demo level exercises the engine path, release checks record the
Blender pre-check that backs traversal, PLAN points at ROADMAP/MEMORY/Screenshots,
and THIRD_PARTY_NOTICES gains rows for the hero facade and the candidate props.

Also fixed the last stale reference to Geo/scripts in MEMORY.md - a sweep found
old paths in six documents after the tool move, which the memory entry now warns
about.
This commit is contained in:
zwitschi committed 2026-11-07 13:21:10 +01:00
1 parent 1a1230ab6b
commit e48a0cd82b
9 files changed
+105 -33
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+16 -12
View File
@@ -4,17 +4,20 @@ A Linux-first Unreal Engine game about walking and driving through a real city.
## Status
Pre-production. The Unreal project, prototype content, and geographic data are tracked; the engine itself is not. Current state is tracked in [ROADMAP.md](ROADMAP.md), and the per-task setup state in [Docs/setup.md](Docs/setup.md).
`0.1.0` is in progress. The workstation, engine, geo pipeline and project bootstrap are done and verified; a walkable `DemoMap` exists with terrain, street, sidewalks, kerbs and the hero façade placed from measured coordinates. Façades are still blockouts, and materials are flat colours — both are planned patches.
Current state is in [ROADMAP.md](ROADMAP.md); what was learned the hard way is in [MEMORY.md](MEMORY.md).
## Layout
| Path | Contents |
| --- | --- |
| `Game/` | Unreal project, configuration, source, game-ready content |
| `Art/` | Editable Blender files and original textures |
| `Geo/` | Source manifests, permitted geographic data, processing scripts |
| `Tools/` | Repeatable import/export helpers |
| `Docs/` | Setup, toolchain pins, licensing, release checks |
| `Art/` | Editable Blender sources, blockouts, terrain, street, hero façade, and a local (uncommitted) reference library |
| `Geo/` | Source manifests, permitted geographic data, and every geographic tool |
| `Tools/` | Unreal-side importers, level builders, and reference gathering |
| `Docs/` | Setup, toolchain pins, build and content pipeline, licensing, release checks |
| `Screenshots/` | Rendered review captures and their approval state |
## Getting started
@@ -24,19 +27,20 @@ git lfs pull
Tools/check-lfs.sh # verifies the lfs filter is active and files are stored as pointers
```
The engine is installed outside the repository and pinned in [Docs/toolchain.md](Docs/toolchain.md). The full procedure is in [Docs/setup.md](Docs/setup.md).
The engine is installed outside the repository and pinned in [Docs/toolchain.md](Docs/toolchain.md). Setup is in [Docs/setup.md](Docs/setup.md); building and the content pipeline are in [Docs/build.md](Docs/build.md).
## Documents
- [ROADMAP.md](ROADMAP.md) — living task list, source of truth for progress
- [PLAN.md](PLAN.md) — scope, stack, release policy, timeline
- [MEMORY.md](MEMORY.md) — shared session memory: discoveries, traps, decisions
- [AGENTS.md](AGENTS.md) — contributor and agent rules
- [MEMORY.md](MEMORY.md) — shared session memory: discoveries, gotchas, bugs
- [Docs/toolchain.md](Docs/toolchain.md) — pinned versions
- [Docs/release-checks.md](Docs/release-checks.md) — release gate definitions
- [Docs/licensing.md](Docs/licensing.md) and [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) — licensing
- [PLAN.md](PLAN.md) — scope, stack, release policy, timeline
- [Docs/toolchain.md](Docs/toolchain.md) · [Docs/environment.md](Docs/environment.md) — pins and workstation audit
- [Docs/build.md](Docs/build.md) — fresh-checkout build and content pipeline
- [Docs/release-checks.md](Docs/release-checks.md) — release gates
- [Docs/licensing.md](Docs/licensing.md) · [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) — licensing
- [CHANGELOG.md](CHANGELOG.md) — release history
## Licensing
Project-owned code, art, and documentation are dedicated under [CC0 1.0](LICENSE). The engine, third-party assets, and geographic data have separate terms; see [Docs/licensing.md](Docs/licensing.md). OSM-derived output carries "© OpenStreetMap contributors".
Code licence is an open decision (MIT proposed). Engine, art, and geographic data are licensed separately; see [Docs/licensing.md](Docs/licensing.md). OSM-derived output carries "© OpenStreetMap contributors".