provisioning-outreach/presentations/pres-prvng/docs/RUN_GUIDE.md

1 line
10 KiB
Markdown
Raw Permalink Normal View History

# 🚀 Run Scripts Guide - Presentation Launcher\n\nConvenient Nushell scripts to launch Provisioning Platform presentations.\n\n## Quick Start\n\n### Option 1: Interactive Menu (Recommended)\n\n```bash\n# Standard version (more features)\nnu run.nu\n\n# Simple version (more compatible)\nnu run-simple.nu\n```\n\nShows a menu to select presentation:\n\n```plaintext\n╔═══════════════════════════════════════════════════════════════╗\n║ Provisioning Platform - Presentation Launcher ║\n╚═══════════════════════════════════════════════════════════════╝\n\n [1] pitch.md │ Executives │ 10 min\n [2] demo-intro.md │ Developers │ 15 min\n [3] talk.md │ Technical │ 30-45 min\n [4] workshop.md │ Learners │ 1-2 hours\n [5] slides.md │ All │ Custom\n\n [Q] Quit\n\nSelect presentation number (1-5):\n```\n\n### Option 2: Direct Launch\n\n```bash\n# Specify presentation as argument\nnu run.nu pitch # Launches pitch.md\nnu run.nu demo-intro # Launches demo-intro.md\nnu run.nu talk.md # Launches talk.md (with .md)\nnu run.nu workshop # Launches workshop.md\n```\n\n### Option 3: NPM Direct (No Script)\n\n```bash\npnpm run dev pitch.md\nnpm run dev talk.md\n```\n\n## Scripts Comparison\n\n| Feature | run.nu | run-simple.nu | run-ultra-simple.nu | pnpm direct |\n|---------|--------|---------------|---------------------|-------------|\n| **Interactive menu** | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No |\n| **Format validation** | ✅ Smart | ✅ Smart | ✅ Smart | ❌ Manual |\n| **File validation** | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No |\n| **Beautiful output** | ✅ Yes | ✅ Basic | ✅ Basic | ❌ No |\n| **Nushell 0.107.1+** | ✅ Required | ✅ 0.95+ | ✅ 0.90+ | N/A |\n| **Information display** | ✅ Detailed | ✅ Basic | ✅ Minimal | ❌ None |\n| **Most compatible** | ❌ | ❌ | ✅ | N/A |\n\n## `run.nu` - Full Version\n\n**Features:**\n\n- Beautiful formatted menu with descriptions\n- Audience and duration information\n- Slide count display\n- Interactive selection with error handling\n- Detailed launch information\n- Requires: Nushell 0.107.1+\n\n**Usage:**\n\n```bash\n# Interactive menu\nnu run.nu\n\n# Direct launch (auto-adds .md if needed)\nnu run.nu pitch\nnu run.nu talk\nnu run.nu demo-intro.md\n```\n\n**Output Example:**\n\n```plaintext\n🚀 Launching presentation: talk.md\n 📺 View at: http://localhost:3030\n ⌨️ Controls: Arrow keys to navigate, S for speaker view, F for fullscreen, ESC for overview\n```\n\n## `run-simple.nu` - Simplified Version\n\n**Features:**\n\n- Compatible with Nushell 0.95+\n- Simple text menu\n- Quick option selection\n- Basic error handling\n- Modern `where` syntax\n\n**Usage:**\n\n```bash\n# Interactive menu\nnu run-simple.nu\n\n# Direct launch\nnu run-simple.nu talk\n```\n\n**Menu Example:**\n\n```plaintext\n[1] pitch.md │ Executives │ 10 min\n[2] demo-intro.md │ Developers │ 15 min\n[3] talk.md │ Technical │ 30-45 min\n[4] workshop.md │ Learners │ 1-2 hours\n[5] slides.md │ All │ Custom\n\nSelect presentation (1-5):\n```\n\n## `run-ultra-simple.nu` - Ultra-Compatible Version\n\n**Features:**\n\n- Maximum compatibility (Nushell 0.90+)\n- No fancy features, just works\n- Traditional loop-based implementation\n- Zero dependencies\n- Requires: Nushell 0.90+\n\n**Usage:**\n\n```bash\n# Interactive menu\nnu run-ultra-simple.nu\n\n# Direct launch\nnu run-ultra-simple.nu talk\n```\n\n**Best For:**\n\n- Older Nushell installations\n- Compatibility-first environments\n- Systems with limited Nushell features\n\n**Note**: If you're getting deprecation warnings with `run.nu` or `run-simple.nu`, use this version