|
| 1 | +# 🌌 Vertex - The Visual Learning Extension for VS Code |
| 2 | + |
| 3 | +**Vertex** is a next-generation educational extension for VS Code that transforms your editor into a mentor. It combines ghost-text guidance, visual call graphs, and motivational AI to help you master coding character-by-character. |
| 4 | + |
| 5 | +## ✨ Key Features |
| 6 | + |
| 7 | +### 🖋️ Teacher's Slate (Learning Mode) |
| 8 | +- **Ghost-Text Guidance**: Follow along with predictive ghost text that appears as you type. Learn syntax by doing. |
| 9 | +- **Real-time Validation**: Instant feedback on every character. Correct matches stay gray; mismatches are highlighted in red. |
| 10 | +- **Zero-Distraction**: Minimalist UI that focuses entirely on the code. |
| 11 | + |
| 12 | +### 🧠 Visual Intelligence |
| 13 | +- **Dynamic Call Graph**: A side-by-side view that traces relationships in your code. |
| 14 | +- **Living Arrows**: Real-time SVG arrows connect variable usage to definitions and function calls to sources. |
| 15 | +- **Cross-Language Support**: Intelligent parsing for **JavaScript/TypeScript, Python, Java, C, and C++**. |
| 16 | + |
| 17 | +### 🧘 Sensei: Motivational AI |
| 18 | +- **Gemini Powered**: Uses Google Gemini to provide context-aware, motivational feedback. |
| 19 | +- **Non-Intrusive**: Feedback appears in the status bar to keep your workspace clean. |
| 20 | +- **Smart Debouncing**: Sensei watches your progress and speaks up when you need a boost. |
| 21 | + |
| 22 | +--- |
| 23 | + |
| 24 | +## 🚀 Quick Start |
| 25 | + |
| 26 | +### 1. Prerequisites |
| 27 | +- **VS Code**: v1.9x+ |
| 28 | +- **Gemini API Key**: If not set in your environment (`GEMINI_API_KEY`), Vertex will securely prompt you for it and store it in your VS Code Secret Storage. |
| 29 | + |
| 30 | +### 2. Loading a Lesson |
| 31 | +Run the command `Vertex: Load Sample Lesson` from the Command Palette (`Ctrl+Shift+P`). |
| 32 | + |
| 33 | +### 3. Visualizing Relationships |
| 34 | +Run the command `Vertex: Show Visual Intelligence` to open the side-by-side visualizer. |
| 35 | + |
| 36 | +--- |
| 37 | + |
| 38 | +## ⚙️ Configuration |
| 39 | + |
| 40 | +| Setting | Description | Default | |
| 41 | +|---------|-------------|---------| |
| 42 | +| `vertex.geminiModel` | Select between `gemini-1.5-flash` or `gemini-1.5-pro` | `gemini-1.5-flash` | |
| 43 | + |
| 44 | +--- |
| 45 | + |
| 46 | +## 🤝 Commands |
| 47 | + |
| 48 | +- `Vertex: Load Sample Lesson` – Start a guided coding lesson. |
| 49 | +- `Vertex: Clear Lesson` – Clear all decorations and active lessons. |
| 50 | +- `Vertex: Show Visual Intelligence` – Toggle the SVG relationship visualizer. |
| 51 | +- `Vertex: Reset Gemini API Key` – Clear your stored key to provide a new one. |
| 52 | + |
| 53 | +--- |
| 54 | +*Built with ❤️ for the next generation of developers.* |
0 commit comments