Skip to content

Commit fbb11f4

Browse files
Add comprehensive README for Vegan Recipe Randomizer
Added detailed documentation including: - Project description and tagline - Features list - Requirements and usage instructions - Complete recipe collection - Example output - Acknowledgments linking to issue sumanth-0#623
1 parent ab971a7 commit fbb11f4

File tree

1 file changed

+85
-0
lines changed

1 file changed

+85
-0
lines changed

Vegan_Recipe_Randomizer/README.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# 🌱 Vegan Recipe Randomizer
2+
3+
> For the days when you want plants, but make it fancy!
4+
5+
## 📖 Description
6+
7+
The Vegan Recipe Randomizer is a Python script that generates random vegan recipes for plant-based meal inspiration. Perfect for anyone trying plant-based meals or looking to try new dishes, this tool helps you discover delicious vegan recipes with just a few keystrokes.
8+
9+
## ✨ Features
10+
11+
- 🎲 **Random Recipe Selection**: Get a random vegan recipe from a curated collection
12+
- 📊 **Filter by Difficulty**: Choose between Easy and Medium difficulty recipes
13+
- ⏱️ **Quick Recipes**: Find recipes that can be made in under 25 minutes
14+
- 📋 **Recipe Collection**: View all available recipes at once
15+
- 🎨 **Beautiful Display**: Recipes displayed with emojis and formatted output
16+
- 💚 **Interactive Menu**: User-friendly command-line interface
17+
18+
## 📦 Requirements
19+
20+
- Python 3.6 or higher
21+
- No external dependencies required (uses only Python standard library)
22+
23+
## 🚀 Usage
24+
25+
1. Run the script:
26+
```bash
27+
python vegan_recipe_randomizer.py
28+
```
29+
30+
2. Choose from the menu options:
31+
- **1**: Get a random recipe from the entire collection
32+
- **2**: Get a random easy recipe
33+
- **3**: Get a random medium difficulty recipe
34+
- **4**: Get a quick recipe (under 25 minutes)
35+
- **5**: Show all available recipes
36+
- **6**: Exit the program
37+
38+
## 🥗 Recipe Collection
39+
40+
The randomizer includes 10 delicious vegan recipes:
41+
42+
1. **Creamy Coconut Curry** (30 min, Easy)
43+
2. **Buddha Bowl Supreme** (25 min, Easy)
44+
3. **Spicy Black Bean Tacos** (20 min, Easy)
45+
4. **Mushroom Stroganoff** (35 min, Medium)
46+
5. **Thai Peanut Noodles** (20 min, Easy)
47+
6. **Lentil Shepherd's Pie** (50 min, Medium)
48+
7. **Vegan Pad Thai** (25 min, Medium)
49+
8. **Mediterranean Hummus Bowl** (15 min, Easy)
50+
9. **Sweet Potato Buddha Bowl** (30 min, Easy)
51+
10. **Vegan Chili** (40 min, Easy)
52+
53+
## 💡 Example Output
54+
55+
```
56+
==================================================
57+
🌱 Thai Peanut Noodles 🌱
58+
==================================================
59+
⏱️ Time: 20 min | 📊 Difficulty: Easy
60+
61+
🥗 Ingredients:
62+
• rice noodles
63+
• peanut butter
64+
• vegetables
65+
• soy sauce
66+
• lime
67+
==================================================
68+
```
69+
70+
## 🤝 Contributing
71+
72+
This project is part of the 100LinesOfPythonCode repository. Contributions are welcome!
73+
74+
## 📝 License
75+
76+
This project follows the license of the parent repository.
77+
78+
## 🙏 Acknowledgments
79+
80+
- Created for issue [#623](https://github.com/sumanth-0/100LinesOfPythonCode/issues/623)
81+
- Part of the [100LinesOfPythonCode](https://github.com/sumanth-0/100LinesOfPythonCode) project
82+
83+
---
84+
85+
**Happy cooking! Stay plant-powered!** 🌿

0 commit comments

Comments
 (0)