返回 ppt-master
README.md
根目录 / examples / README.md
1 # PPT Master Example Projects
2
3 > Curated example projects generated by PPT Master.
4
5 > Example artifacts are frozen snapshots of the workflow and capability boundary that generated them. Their `design_spec.md` and `spec_lock.md` files may retain rules that were later relaxed; they are historical evidence, not current SVG authoring authority. Use [`shared-standards.md`](../skills/ppt-master/references/shared-standards.md) for current required, forbidden, and conditional rules.
6
7 **[Browse all examples online](https://hugohe3.github.io/ppt-master/)** — the canonical catalog, powered by [`examples.json`](./examples.json). The JSON file is the source of truth for project metadata, tags, and slide listings; this README only documents folder structure.
8
9 ## Project Structure
10
11 Each example follows this layout:
12
13 ```
14 <project_name>/
15 ├── design_spec.md # Design specification (human-readable)
16 ├── spec_lock.md # Machine-readable execution contract
17 ├── images/ # Image assets
18 ├── notes/ # Speaker notes per page
19 ├── svg_output/ # Original SVGs (with placeholders)
20 └── svg_final/ # Self-contained preview SVGs (icons + images embedded)
21 ```
22
23 > Examples deliberately omit `sources/` (original PDFs / DOCX) and `exports/` (PPTX output) to keep repo size small. Real projects under `projects/` will have both.
24
25 ## Preview locally
26
27 ```bash
28 python -m http.server --directory examples/<project_name>/svg_final 8000
29 # visit http://localhost:8000
30 ```
31
32 Or open any `svg_final/*.svg` directly in a browser / VS Code.
33
34 ## Contributing
35
36 New or deliberately refreshed examples need (1) the standard structure above and (2) an entry in [`examples.json`](./examples.json) (`projects[]` array + bumped `stats`). Their SVGs should pass `python3 skills/ppt-master/scripts/svg_quality_checker.py`; existing frozen snapshots are not retroactively rewritten solely to match a newer authoring policy.
37
38 ## Related
39
40 - [Quick Start](../README.md)
41 - [Workflow](../skills/ppt-master/SKILL.md)
42 - [Chart Templates](../skills/ppt-master/templates/charts/)
43 - [Icon Library](../skills/ppt-master/templates/icons/)
44
44 lines MARKDOWN