Spaces:
Sleeping
Sleeping
| # 🎮 Quick Start Guide - Eidolon Cognitive Tutor | |
| ## 🚀 Get Started in 30 Seconds | |
| ### Step 1: Pick Your Learning Mode | |
| Click one of the mode buttons at the top: | |
| - 📚 **Standard** - Start here if you're unsure | |
| - 🤔 **Socratic** - Answer questions to learn | |
| - 👶 **ELI5** - Super simple explanations | |
| - 🔬 **Technical** - Deep technical details | |
| - 🎭 **Analogy** - Learn through comparisons | |
| - 💻 **Code** - See code examples | |
| ### Step 2: Set Your Difficulty | |
| Drag the slider: | |
| - **1-2**: Just starting out? Go beginner! | |
| - **3**: Most people start here (balanced) | |
| - **4-5**: Ready for advanced concepts? Crank it up! | |
| ### Step 3: Choose Your Tutor's Vibe | |
| Pick a persona: | |
| - 😊 **Friendly** - Warm and supportive (recommended for beginners) | |
| - 📚 **Strict** - Academic and direct | |
| - 🎉 **Enthusiastic** - High-energy and motivating | |
| - 🎓 **Professional** - Formal and structured | |
| ### Step 4: Ask Your Question! | |
| Type anything: | |
| - "Explain black holes" | |
| - "How does the internet work?" | |
| - "What is machine learning?" | |
| - "Teach me about recursion" | |
| Or click an example card to try instantly! | |
| --- | |
| ## 🎯 Pro Tips | |
| ### Get Better Answers | |
| - **Be specific**: "Explain HTTP caching" beats "Tell me about HTTP" | |
| - **Use the enhance button**: ✨ Click to get AI-suggested improvements | |
| - **Try multiple modes**: Same question, different perspectives! | |
| ### Build Your Streak | |
| - Come back daily to maintain your 🔥 streak | |
| - Track your progress in the stats bar | |
| - Unlock achievements by exploring features | |
| ### Experiment! | |
| - **Mode + Difficulty combo**: Try "Technical Mode + Level 5" for expert content | |
| - **Persona switching**: See how "Strict" differs from "Playful" | |
| - **Copy responses**: 📋 Save great explanations for later | |
| --- | |
| ## 🏆 Achievement Hunting | |
| Unlock these badges: | |
| 1. **🌟 Getting Started** - Ask your first question (easy!) | |
| 2. **🎓 Curious Learner** - Ask 10 questions | |
| 3. **🔥 Knowledge Seeker** - Ask 50 questions (impressive!) | |
| 4. **🎨 Mode Master** - Try all 6 learning modes | |
| Your progress is saved automatically in your browser! | |
| --- | |
| ## 🎓 Best Practices by Use Case | |
| ### For Students | |
| ``` | |
| Mode: Socratic or ELI5 | |
| Difficulty: 1-3 | |
| Persona: Friendly | |
| Why: Builds understanding through questions and simple language | |
| ``` | |
| ### For Developers | |
| ``` | |
| Mode: Code or Technical | |
| Difficulty: 3-4 | |
| Persona: Professional | |
| Why: Practical examples with technical depth | |
| ``` | |
| ### For Quick Learning | |
| ``` | |
| Mode: Analogy or ELI5 | |
| Difficulty: 2 | |
| Persona: Enthusiastic | |
| Why: Fast comprehension through relatable comparisons | |
| ``` | |
| ### For Exam Prep | |
| ``` | |
| Mode: Technical or Standard | |
| Difficulty: 4-5 | |
| Persona: Strict | |
| Why: Rigorous, comprehensive explanations | |
| ``` | |
| --- | |
| ## 🆘 Common Questions | |
| **Q: What's the difference between modes?** | |
| A: Each mode teaches differently: | |
| - *Socratic* asks you questions | |
| - *ELI5* uses simple words | |
| - *Technical* goes deep | |
| - *Analogy* compares to familiar things | |
| - *Code* shows examples | |
| **Q: How do I track my progress?** | |
| A: Check the stats bar at the top! It shows: | |
| - Total questions asked | |
| - Current learning streak | |
| - Achievements earned | |
| **Q: Can I go back to previous answers?** | |
| A: Yes! Scroll down to see your conversation history (if enabled). | |
| **Q: What happens if I leave and come back?** | |
| A: Your stats, achievements, and streak are saved in your browser! | |
| **Q: Is this real AI or a demo?** | |
| A: It can be both! Set `DEMO_MODE=1` for instant demo responses, or configure an inference API for real AI. | |
| --- | |
| ## 🎨 UI Walkthrough | |
| ### Top Bar | |
| - **Question Counter**: Total questions asked | |
| - **Streak**: Days of consecutive use 🔥 | |
| - **Achievements**: Badges earned 🏆 | |
| ### Mode Selector | |
| Six colorful buttons - click to switch learning style instantly. | |
| ### Controls Panel | |
| - **Difficulty Slider**: Drag left (easier) or right (harder) | |
| - **Persona Buttons**: Click to change tutor personality | |
| ### Chat Area | |
| - **Text Input**: Type your question here | |
| - **Action Buttons**: Ask, Enhance, Clear, Surprise Me | |
| - **Response Area**: AI answers appear here with typing animation | |
| - **Example Cards**: Click for instant question starters | |
| ### Response Actions | |
| - **📋 Copy**: Save to clipboard | |
| - **🔗 Share**: Share this Q&A | |
| - **🔄 Regenerate**: Get a new answer | |
| --- | |
| ## 💡 Cool Tricks | |
| ### The "Compare" Trick | |
| Ask the same question in two modes side-by-side: | |
| 1. Ask in ELI5 mode | |
| 2. Switch to Technical mode | |
| 3. Ask again | |
| 4. Compare the depth and style! | |
| ### The "Difficulty Ladder" | |
| Progressive learning: | |
| 1. Start at difficulty 1 | |
| 2. Ask about a topic | |
| 3. Increase to 3, ask follow-up | |
| 4. Jump to 5 for advanced details | |
| ### The "Persona Test" | |
| See personality in action: | |
| 1. Ask "Why is math important?" | |
| 2. Try with each persona | |
| 3. Notice the tone differences! | |
| ### The "Surprise Challenge" | |
| Click "🎲 Surprise Me" → Get a random interesting question → Try to answer before the tutor! | |
| --- | |
| ## 🚀 Next Steps | |
| 1. **Start Simple**: Try an example card | |
| 2. **Experiment**: Switch modes mid-conversation | |
| 3. **Track Progress**: Watch your stats grow | |
| 4. **Earn Badges**: Unlock all achievements | |
| 5. **Share**: Tell friends about cool explanations you got! | |
| --- | |
| **Need help?** Check out [FEATURES.md](./FEATURES.md) for detailed documentation! | |
| **Found a bug?** Open an issue on [GitHub](https://github.com/Zwin-ux/Eidolon-Cognitive-Tutor/issues)! | |
| --- | |
| **Happy Learning! 🎓✨** | |