Skip to content

Commit 017f86f

Browse files
committed
docs: finalize visual presentation and launch readiness meta
1 parent af9e636 commit 017f86f

1 file changed

Lines changed: 20 additions & 5 deletions

File tree

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,21 @@ Conversely, passing technical specs to non-technical agencies or standard AI vid
1414

1515
## Gallery & Visuals
1616

17-
The engine is optimized for high-fidelity technical storytelling. Expected artifacts from the render pipeline include:
17+
TechDemoForge focuses on technical honesty and structural precision. These visuals demonstrate the transition from engineering specs to verifiable video assets.
1818

19-
* **Storyboards**: [gallery/storyboard-sample.png](gallery/storyboard-sample.png)
20-
* **Media Assets**: [gallery/scene-render-sample.mp4](gallery/scene-render-sample.mp4)
21-
* **Final Output**: [gallery/final-demo-release.mp4](gallery/final-demo-release.mp4)
19+
| 1. Source Ingestion | 2. MiniMax-M2.7 Storyboard |
20+
| :--- | :--- |
21+
| ![Ingestion](docs/assets/screenshots/01-ingestion.png) | ![Storyboard](docs/assets/screenshots/02-storyboard.png) |
22+
| *Ingest dense READMEs or specs.* | *MiniMax-M2.7 plans the narrative.* |
2223

24+
| 3. Async Media Workers | 4. Final Render Output |
25+
| :--- | :--- |
26+
| ![Background Jobs](docs/assets/screenshots/03-workers.png) | ![Final Render](docs/assets/screenshots/04-render.png) |
27+
| *Track jobs via persistent workers.* | *FFmpeg muxes the final artifacts.* |
28+
29+
### Interactive Walkthrough
2330
> [!TIP]
24-
> Use the **Mock Mode** during initial setup to generate watermarked placeholders for these assets without incurring API costs.
31+
> View the [Full Pipeline Demo GIF](docs/assets/demo/walkthrough-pipeline.gif) to see the end-to-end flow from planning to MP4 export.
2532
2633
## Architecture & Workflow
2734

@@ -131,6 +138,14 @@ Best for development if you have Python 3.10+ and Node.js installed locally.
131138
- **Video Generation**: Wired and active when configured. targetting `MiniMax-Hailuo-02` via async background workers.
132139
- **Mock Mode**: Fully functional zero-configuration fallback for offline testing.
133140

141+
## Demo Asset Guidelines
142+
143+
When contributing screenshots or demo GIFs to `docs/assets/`:
144+
- **Resolution**: 1280x720 (720p) is preferred for a balance of clarity and file size.
145+
- **GIF Duration**: Keep walkthrough GIFs under 15 seconds; use high compression (e.g., via `ffmpeg` or `ezgif`).
146+
- **Formatting**: Use descriptive names (e.g., `01-ingestion.png`) to maintain logical ordering in the documentation.
147+
- **No Sensitive Data**: Ensure all API keys and personal identifiers are redacted or cleared before capture.
148+
134149
## Manual QA Checklist
135150

136151
Before each push or release tag, verify the following:

0 commit comments

Comments
 (0)