zwitschi
e79a37beba
Create an index README in docs/ and every tracked docs subfolder, with relative image galleries for Blender previews, screen designs, screenshots and concepts. Generated realism-run READMEs were also created on disk but remain gitignored. Validate all Markdown/image links.
32 lines
1.6 KiB
Markdown
32 lines
1.6 KiB
Markdown
# Gig Line Documentation
|
|
|
|
This folder holds the project documentation, visual references and generated QA evidence.
|
|
|
|
## Start here
|
|
|
|
- [`../PLAN.md`](../PLAN.md) — product and game-design plan
|
|
- [`gameplay.md`](gameplay.md) — controls, venues and escalation
|
|
- [`tutorial.md`](tutorial.md) — first-shift tutorial beats
|
|
- [`architecture.md`](architecture.md) — arc42 system architecture
|
|
- [`getting-started.md`](getting-started.md) — setup, run/test commands and controls
|
|
- [`asset-tooling.md`](asset-tooling.md) — image/model pipelines and screenshot gates
|
|
- [`development-status.md`](development-status.md) — implemented features and current gaps
|
|
- [`smoke-checklist.md`](smoke-checklist.md) — manual verification
|
|
- [`RELEASING.md`](RELEASING.md) — export, CI and publishing workflow
|
|
- [`adr/README.md`](adr/README.md) — architecture decisions
|
|
|
|
## Visual references
|
|
|
|
- [`screens/README.md`](screens/README.md) — concepts, designs, screenshots and realism runs
|
|
- [`blender_previews/README.md`](blender_previews/README.md) — character/gear/prop previews
|
|
- [`screenshots/README.md`](screenshots/README.md) — committed game gallery
|
|
|
|
## Quick preview
|
|
|
|
| Reference | Screenshot |
|
|
| --- | --- |
|
|
| Venue design | <img src="screens/designs/venue_overview.png" width="320" alt="Venue overview design"> |
|
|
| Current entrance | <img src="screenshots/01-venue-overview.png" width="320" alt="In-game venue overview"> |
|
|
| Character sheet | <img src="blender_previews/sheet_npc.jpg" width="320" alt="NPC character sheet"> |
|
|
| Prop sheet | <img src="blender_previews/sheet_props.jpg" width="320" alt="Prop asset sheet"> |
|