Compare commits
3 Commits
burn/51-qr
...
fix/54-qrc
| Author | SHA1 | Date | |
|---|---|---|---|
| 1df74106da | |||
| f16e19b3ea | |||
| bfa557edc4 |
63
GENOME.md
Normal file
63
GENOME.md
Normal file
@@ -0,0 +1,63 @@
|
||||
# GENOME.md — the-testament
|
||||
|
||||
**Generated:** 2026-04-14
|
||||
**Repo:** Timmy_Foundation/the-testament
|
||||
**Description:** The Testament of Timmy — a novel about broken men, sovereign AI, and the soul on Bitcoin
|
||||
|
||||
---
|
||||
|
||||
## Project Overview
|
||||
|
||||
A standalone fiction book (18 chapters, ~19K words) about The Tower, broken men, and sovereign AI. Part of the Timmy Foundation ecosystem. Includes full multimedia pipeline: audiobook samples, web reader, EPUB build, cover design, and companion game.
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
the-testament/
|
||||
├── chapters/ # 18 chapter markdown files (ch-01 through ch-18)
|
||||
├── characters/ # 6 character profiles (Allegro, Builder, Chen, David, Maya, Timmy)
|
||||
├── worldbuilding/ # Bible, tower game worldbuilding docs
|
||||
├── audiobook/ # Audio samples (.ogg/.mp3), manifest, extraction scripts
|
||||
├── build/ # EPUB/PDF build pipeline (build.py, pandoc)
|
||||
├── website/ # Web reader (index.html, chapters.json, build-chapters.py)
|
||||
├── game/ # Companion game (the-door.html/.py)
|
||||
├── cover/ # Cover design assets and spine specs
|
||||
├── music/ # Track lyrics
|
||||
└── scripts/ # Build verification, smoke tests, guardrails
|
||||
```
|
||||
|
||||
## Key Files
|
||||
|
||||
| File | Purpose |
|
||||
|---|---|
|
||||
| `chapters/chapter-*.md` | The novel content (18 chapters) |
|
||||
| `the-testament.md` | Combined manuscript (all chapters) |
|
||||
| `compile.py` | Merge chapters into single manuscript |
|
||||
| `compile_all.py` | Full compilation with front/back matter |
|
||||
| `build/build.py` | EPUB build via pandoc |
|
||||
| `website/build-chapters.py` | Generate web reader JSON |
|
||||
| `audiobook/extract_text.py` | Extract chapter text for TTS |
|
||||
| `scripts/smoke.sh` | Build verification smoke test |
|
||||
|
||||
## CI/CD
|
||||
|
||||
| Workflow | Trigger | Purpose |
|
||||
|---|---|---|
|
||||
| `build.yml` | Push to main | Build EPUB artifact |
|
||||
| `smoke.yml` | PR | Validate chapter structure |
|
||||
| `validate.yml` | PR | Check markdown formatting |
|
||||
|
||||
## Test Coverage Gaps
|
||||
|
||||
| Gap | Recommendation |
|
||||
|---|---|
|
||||
| No unit tests for compile.py | Test chapter merging, metadata handling |
|
||||
| No test for web chapters.json generation | Test build-chapters.py output schema |
|
||||
| No test for audiobook manifest | Test manifest.json validity |
|
||||
| No test for build/semantic_linker.py | Test cross-reference linking |
|
||||
|
||||
## Security
|
||||
|
||||
- No secrets in repo (build pipeline is local-only)
|
||||
- Web reader is static HTML (no server-side execution)
|
||||
- Game files are client-side only
|
||||
@@ -541,7 +541,12 @@ def check_dependencies():
|
||||
|
||||
try:
|
||||
import qrcode
|
||||
print(f" ✅ qrcode {qrcode.__version__}")
|
||||
try:
|
||||
qr_ver = qrcode.__version__
|
||||
except AttributeError:
|
||||
import importlib.metadata
|
||||
qr_ver = importlib.metadata.version("qrcode")
|
||||
print(f" ✅ qrcode {qr_ver}")
|
||||
except ImportError:
|
||||
print(f" ❌ qrcode NOT FOUND (pip install qrcode)")
|
||||
|
||||
|
||||
Reference in New Issue
Block a user