📖 Using This Repository¶
This guide explains how VibeLearning is organized and how to get the most out of it.
Repository Structure¶
VibeLearning/
├── README.md # Start here
├── PROGRESS.md # Track what's implemented
├── ROADMAP.md # Your learning path
│
├── 00_getting_started/ # You are here!
├── 01_foundations/ # Core programming concepts
├── 02_data_structures/ # How to organize data
├── 03_algorithms/ # Problem-solving techniques
│ ... # More modules
│
├── exercises/ # Practice problems
├── projects/ # Complete projects to build
└── Resources/ # Cheatsheets, glossary, etc.
How Each Concept Is Organized¶
Every concept folder follows the same structure:
concept_name/
├── README.md # 📚 Theory and explanations
├── examples.py # 💻 Runnable code examples
├── exercises.py # ✏️ Practice problems
└── quiz.md # ❓ Test your understanding
README.md¶
- What: Theory, explanations, real-world analogies
- How to use: Read through first to understand the concept
- Goal: Build mental model before coding
examples.py¶
- What: Working code demonstrating the concept
- How to use: Run the file, then read through the code
- Goal: See the concept in action
exercises.py¶
- What: Practice problems with solutions
- How to use: Try solving before looking at answers
- Goal: Reinforce learning through practice
quiz.md¶
- What: Questions to test your understanding
- How to use: Answer without looking back at notes
- Goal: Identify gaps in knowledge
Recommended Learning Workflow¶
For each concept:
1. 📚 Read README.md
↓
2. 💻 Run and study examples.py
↓
3. ✏️ Attempt exercises.py
↓
4. ❓ Take the quiz.md
↓
5. 🔄 Review if needed
Time Per Concept¶
- Simple concepts: 30-60 minutes
- Medium concepts: 1-2 hours
- Complex concepts: 2-4 hours
Tips for Effective Learning¶
Do's ✅¶
| Tip | Why |
|---|---|
| Type code yourself | Muscle memory matters |
| Run examples before reading | See behavior first, then understand |
| Modify examples | Experimenting deepens understanding |
| Make mistakes | Errors are learning opportunities |
| Take breaks | Your brain consolidates during rest |
| Teach others | Best way to solidify knowledge |
Don'ts ❌¶
| Avoid | Why |
|---|---|
| Copy-pasting code | You won't remember it |
| Rushing through | Understanding beats speed |
| Skipping exercises | Practice makes permanent |
| Ignoring errors | They teach you how things work |
Tracking Your Progress¶
Use PROGRESS.md at the root to see:
- Which modules are complete
- What's currently in development
- Overall completion percentage
You can also create your own progress tracker:
# My Learning Progress
## Completed ✅
- [x] 00_getting_started
- [x] 01_foundations/01_variables_and_types
## In Progress 🔄
- [ ] 01_foundations/02_operators
## Notes
- Review variable naming conventions
- Practice more with string formatting
Need Help?¶
If Code Doesn't Run:¶
- Check for typos
- Make sure you're in the right directory
- Verify Python is installed correctly
- Read the error message carefully
If Concept Doesn't Make Sense:¶
- Re-read the README.md slowly
- Run more examples
- Try explaining it to yourself out loud
- Take a break and come back later
- Search online for alternative explanations
🎉 You're Ready!¶
You now know: - ✅ How the repository is organized - ✅ What each file type contains - ✅ The recommended learning workflow - ✅ Tips for effective learning
Next up: 01_foundations — Start learning the building blocks of programming!