Skip to content

Commit 609aadb

Browse files
Refactor README for better presentation and details
Updated README to improve formatting and clarity.
1 parent d337647 commit 609aadb

File tree

1 file changed

+50
-24
lines changed

1 file changed

+50
-24
lines changed

random-quote-generator/README.md

Lines changed: 50 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,80 @@
1-
## 🌟 Random Quote Generator
1+
<h1 align="center"> Random Quote Generator (Python)</h1>
22

3-
A simple Python command-line application that displays a random motivational quote every time it runs. Perfect for a quick dose of inspiration! ✨
3+
<p align="center">
4+
A lightweight <b>Python command-line application</b> that displays a random motivational quote each time it runs.
5+
Perfect for a quick dose of inspiration anytime you need a boost!
6+
</p>
47

5-
## 🚀 Features
8+
<p align="center">
9+
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/Python-3.x-blue?style=for-the-badge&logo=python"></a>
10+
<a href="#"><img src="https://img.shields.io/badge/Platform-Terminal-orange?style=for-the-badge&logo=windowsterminal"></a>
11+
<a href="https://github.com/mantrapatil03/python-beginner-friendly-projects"><img src="https://img.shields.io/github/stars/mantrapatil03/python-beginner-friendly-projects?style=for-the-badge&logo=github"></a>
12+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-green?style=for-the-badge&logo=opensourceinitiative"></a>
13+
</p>
614

7-
📝 Generates a random motivational quote each time you run the program.
15+
---
816

9-
🔄 Option to get another quote or exit the program.
17+
## Features
1018

11-
💡 Lightweight, simple, and easy to use.
19+
- **Random Quote Generator** – Displays a new motivational quote every time
20+
- **Get Another Quote** – Press Enter to see a new one instantly
21+
- **Exit Option** – Type `exit` to quit the program
22+
- **Lightweight & Beginner-Friendly** – Simple Python script, easy to read and extend
1223

24+
---
1325

1426
## 🎬 Demo
1527
```
1628
$ python random_quote_generator.py
1729
18-
Random Quote Generator
30+
🌟 Random Quote Generator
1931
2032
"Don’t let yesterday take up too much of today. – Will Rogers"
2133
2234
Press Enter to get another quote or type 'exit' to quit:
2335
```
24-
## 🛠 Installation
2536

26-
1. Make sure you have `Python 3.x` installed 🐍.
27-
28-
29-
2. Clone this repository:
37+
---
3038

39+
## Installation & Setup
3140

41+
### 1️⃣ Prerequisites
42+
Make sure **Python 3.x** is installed:
43+
```bash
44+
python --version
45+
```
46+
2️⃣ Clone the Repository
3247
```
33-
git clone https://github.com/mantrapatil03/python-beginner-friendly-projects/random-quote-generator.git
48+
git clone https://github.com/mantrapatil03/python-beginner-friendly-projects.git
49+
cd python-beginner-friendly-projects/random-quote-generator
50+
```
51+
3️⃣ Run the Program
52+
```
53+
python random_quote_generator.py
3454
```
3555

36-
3. Navigate to the project folder:
56+
## Usage
57+
- Press Enter to generate a new random quote
58+
- Type exit to quit the program
3759

3860

39-
```
40-
cd random-quote-generator
41-
```
42-
4. Run the program:
4361

44-
```
62+
## Future Roadmap
63+
| Feature | Status | Description |
64+
| ------------------ | :-------: | ----------------------------------------- |
65+
| Web version | Planned | Display quotes on a Flask web app |
66+
| GUI version | Planned | Build a Tkinter or PyQt interface |
67+
| Save favorites | Planned | Let users save favorite quotes locally |
68+
| API integration | Planned | Fetch quotes dynamically from online APIs |
69+
| Quote analytics | Planned | Track favorite categories or usage stats |
4570

46-
python random_quote_generator.py
47-
```
48-
## 💡 Usage
71+
## Author
72+
**Mantra Patil**
73+
74+
💼 LinkedIn: https://www.linkedin.com/in/mantrapatil25
4975

50-
Press Enter to get a new random quote ✨.
76+
✉️ techmantrapatil@gmail.com
5177

52-
Type exit to quit the program ❌.
5378

5479

80+
<h3 align="center">🌟 If you found this project useful, give it a ⭐ on GitHub! 🌟</h3> <p align="center"> <img src="https://img.shields.io/badge/Stay%20Inspired%20%26%20Keep%20Coding!-Python-blue?style=for-the-badge&logo=python"> </p>

0 commit comments

Comments
 (0)