|
| 1 | +# Demo Time Act files |
| 2 | + |
| 3 | +This folder contains demonstration files for **Demo Time** using the new |
| 4 | +**Version 3** theatrical structure. |
| 5 | + |
| 6 | +## 🎭 Theatrical Structure |
| 7 | + |
| 8 | +Demo Time uses an intuitive theatrical metaphor: |
| 9 | + |
| 10 | +- **Play** - Your entire demo project (this workspace) |
| 11 | +- **Act** - Each act file (e.g., `example-v3.yaml` or `my-demo.json`) |
| 12 | +- **Scene** - Sections within an Act (previously called "demos") |
| 13 | +- **Move** - Individual actions (previously called "steps") |
| 14 | + |
| 15 | +## 📁 Files in This Folder |
| 16 | + |
| 17 | +### Version 3 (New Format) |
| 18 | + |
| 19 | +- **`example-v3.yaml`** - Example demonstration using version 3 theatrical |
| 20 | + naming |
| 21 | + - Shows the new `scenes` and `moves` structure |
| 22 | + - Demonstrates product icon usage |
| 23 | + - YAML format |
| 24 | + |
| 25 | +### Version 1 & 2 (Legacy Format) |
| 26 | + |
| 27 | +- **`demo.json`** - Legacy JSON format demo |
| 28 | +- **`sample.json`** - Sample act file |
| 29 | +- **`sample.yaml`** - Sample YAML act file |
| 30 | +- Other `.json` and `.yaml` files - Various demo examples |
| 31 | + |
| 32 | +## 🚀 Quick Start |
| 33 | + |
| 34 | +### Creating a New Version 3 Demo |
| 35 | + |
| 36 | +Create a file named `my-demo.yaml` (or `my-demo.json`): |
| 37 | + |
| 38 | +```yaml |
| 39 | +title: My Demo Act |
| 40 | +description: What this Act demonstrates |
| 41 | +version: 3 |
| 42 | +scenes: |
| 43 | + - title: Introduction Scene |
| 44 | + moves: |
| 45 | + - action: showInfoMessage |
| 46 | + message: Hello from Demo Time v3! |
| 47 | +``` |
| 48 | +
|
| 49 | +### Product Icons |
| 50 | +
|
| 51 | +Choose from any VS Code codicon: |
| 52 | +- `presentation` - General presentations |
| 53 | +- `rocket` - Getting started |
| 54 | +- `lightbulb` - Features |
| 55 | +- `beaker` - Experiments |
| 56 | +- `terminal` - CLI demos |
| 57 | +- `code` - Coding tutorials |
| 58 | + |
| 59 | +## 📚 Documentation |
| 60 | + |
| 61 | +- **Complete Guide:** `/docs/version-3-guide.md` |
| 62 | +- **Migration Guide:** `/MIGRATION-V3.md` |
| 63 | +- **Schema:** `https://demotime.show/demo-time.schema.json` |
| 64 | + |
| 65 | +## ✨ Version 3 Features |
| 66 | + |
| 67 | +- ✅ Theatrical naming (Play, Act, Scene, Move) |
| 68 | +- ✅ Product icons for visual identification |
| 69 | +- ✅ Works with `.json` and `.yaml` files |
| 70 | +- ✅ Full backward compatibility with v1 & v2 |
| 71 | +- ✅ Automatic normalization |
| 72 | + |
| 73 | +## 🔄 Backward Compatibility |
| 74 | + |
| 75 | +All existing `.json` and `.yaml` act files continue to work without |
| 76 | +modification. You can mix version 1, 2, and 3 files in the same project. |
| 77 | + |
| 78 | +## 🎬 Example Structure |
| 79 | + |
| 80 | +```yaml |
| 81 | +title: Getting Started |
| 82 | +version: 3 |
| 83 | +scenes: |
| 84 | + - title: Installation |
| 85 | + moves: |
| 86 | + - action: create |
| 87 | + path: package.json |
| 88 | + content: {...} |
| 89 | + - action: open |
| 90 | + path: package.json |
| 91 | +
|
| 92 | + - title: First Steps |
| 93 | + moves: |
| 94 | + - action: showInfoMessage |
| 95 | + message: You're all set! |
| 96 | +``` |
| 97 | + |
| 98 | +## 📖 Learn More |
| 99 | + |
| 100 | +Visit [demotime.show](https://demotime.show/) for complete documentation and |
| 101 | +examples. |
0 commit comments