@@ -3,11 +3,43 @@ title: Quick Start
33description : Create your first LUMOS schema in 5 minutes
44---
55
6- Welcome to LUMOS! This guide will walk you through creating your first schema and generating code in just a few minutes.
6+ # LUMOS in 5 Minutes ⚡
7+
8+ Welcome to LUMOS! This guide will get you from zero to working schema in ** exactly 5 minutes** .
9+
10+ ::: tip [ Time Commitment]
11+ ⏱️ ** Total Time: 5 minutes**
12+ - Installation: 1 minute
13+ - First Schema: 1 minute
14+ - Generate Code: 30 seconds
15+ - Review Output: 1 minute
16+ - Use in Project: 1.5 minutes
17+ :::
718
819---
920
10- ## 1. Initialize a Project
21+ ## Minute 1: Installation
22+
23+ First, install the LUMOS CLI:
24+
25+ ``` bash
26+ cargo install lumos-cli
27+ ```
28+
29+ ** Verify installation:**
30+ ``` bash
31+ lumos --version
32+ # Output: lumos-cli 0.1.0
33+ ```
34+
35+ ** Optional:** Install VSCode extension for syntax highlighting:
36+ ``` bash
37+ code --install-extension lumos.lumos-vscode
38+ ```
39+
40+ ---
41+
42+ ## Minute 2: Initialize Project & Write Schema
1143
1244Create a new LUMOS project:
1345
@@ -62,11 +94,12 @@ struct MatchResult {
6294
6395---
6496
65- ## 3. Generate Code
97+ ## Minute 3: Generate Code (30 seconds!)
6698
6799Generate Rust and TypeScript code from your schema:
68100
69101``` bash
102+ cd my-game
70103lumos generate schema.lumos
71104```
72105
@@ -88,7 +121,7 @@ You now have:
88121
89122---
90123
91- ## 4. Inspect Generated Code
124+ ## Minute 4: Inspect Generated Code
92125
93126### Rust Output (` generated.rs ` )
94127
@@ -154,7 +187,7 @@ export const MatchResultBorshSchema = borsh.struct([
154187
155188---
156189
157- ## 5. Use in Your Project
190+ ## Minute 5: Use in Your Anchor Program
158191
159192### In your Anchor program:
160193
@@ -218,7 +251,27 @@ async function getPlayerAccount(
218251
219252---
220253
221- ## 6. Development Workflow
254+ ## 🎉 You're Done! (5 Minutes Complete)
255+
256+ ** Congratulations!** In just 5 minutes you:
257+
258+ ✅ Installed LUMOS CLI
259+ ✅ Created your first ` .lumos ` schema
260+ ✅ Generated type-safe Rust + TypeScript code
261+ ✅ Saw how to use it in Anchor programs
262+ ✅ Learned the complete LUMOS workflow
263+
264+ ** What you got:**
265+ - Type-safe schemas shared between Rust and TypeScript
266+ - Automatic Borsh serialization
267+ - Zero manual boilerplate
268+ - Anchor-ready code
269+
270+ ** Next:** Build something real! Check out [ complete examples →] ( /examples/ )
271+
272+ ---
273+
274+ ## Beyond 5 Minutes: Development Workflow
222275
223276### Validate Syntax
224277
0 commit comments