Skip to content

Commit 163a974

Browse files
Revise README for Advanced Alarm Clock features
Updated README to reflect advanced features and modern design.
1 parent c10f123 commit 163a974

File tree

1 file changed

+74
-57
lines changed

1 file changed

+74
-57
lines changed

alarm-clock/README.md

Lines changed: 74 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,106 @@
1-
# ⏰ Simple Alarm Clock (Python + Tkinter)
2-
3-
A lightweight **Alarm Clock GUI application** built using Python's `tkinter`.
4-
You can set an alarm in **HH:MM:SS format**, and the app will alert you when the time is reached.
1+
<h1 align="center"> Advanced Alarm Clock (Python + Tkinter)</h1>
2+
3+
<p align="center">
4+
A simple yet powerful <b>Alarm Clock GUI application</b> built using <b>Python</b> and <b>Tkinter</b> .
5+
Set alarms easily, get notified when time’s up, and enjoy a clean, modern interface.
6+
Perfect for beginners exploring GUI programming with Python.
7+
</p>
8+
9+
<p align="center">
10+
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/Python-3.8+-blue?style=for-the-badge&logo=python"></a>
11+
<a href="https://docs.python.org/3/library/tkinter.html"><img src="https://img.shields.io/badge/GUI-Tkinter-ff69b4?style=for-the-badge&logo=python"></a>
12+
<a href="https://github.com/mantrapatil03/python-beginner-friendly-projects/stargazers"><img src="https://img.shields.io/github/stars/mantrapatil03/python-beginner-friendly-projects?style=for-the-badge&logo=github"></a>
13+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-green?style=for-the-badge&logo=opensourceinitiative&logoColor=white"></a>
14+
<a href="#"><img src="https://img.shields.io/badge/Platform-Cross%20Platform-orange?style=for-the-badge&logo=windows"></a>
15+
</p>
516

617
---
718

8-
## 🚀 Features
9-
- 🕒 Set alarm time in **HH:MM:SS format**
10-
- ✅ Validates input (shows error popup if format is wrong)
11-
- 🔔 Alarm rings with a popup message
12-
- ⏹ Stop button to cancel the alarm anytime
13-
- 🎨 Simple and responsive Tkinter GUI
19+
## Features
20+
21+
- **Set Alarms** – Enter time in `HH:MM:SS` format
22+
- **Input Validation** – Shows error message for invalid formats
23+
- **Popup Alerts** – Alarm notification when time is reached
24+
- **Stop Alarm Button** – Cancel active alarms easily
25+
- **Responsive Tkinter GUI** – Clean, minimal design with clear controls
26+
- **Lightweight & Beginner-Friendly** – Easy to understand and extend
1427

1528
---
1629

17-
## 📂 Project Structure
18-
```
19-
|-- HOW_IT_WORKS.MD # Working
20-
|-- README.md # Project documentation
21-
|-- alarm_clock.py # Main program file
22-
|-- requirements.md # Dependencies
23-
```
2430

2531
---
2632

27-
## 🛠 Requirements
28-
29-
- Python **3.8+**
30-
31-
- Tkinter (comes pre-installed with Python)
32-
33-
- datetime (Python standard library)
33+
## Requirements
3434

35-
To check if Tkinter is installed, run:
35+
| Dependency | Description |
36+
|-------------|-------------|
37+
| **Python 3.8+** | Core programming language |
38+
| **Tkinter** | GUI framework (preinstalled with Python) |
39+
| **datetime** | For time management |
3640

41+
Check if Tkinter is available:
3742
```python
3843
import tkinter
3944
print("Tkinter is working!")
4045
```
46+
If missing on Linux, install it with:
47+
```
48+
sudo apt-get install python3-tk
49+
```
50+
## How to Run
4151

42-
If not installed on Linux:
43-
44-
```sudo apt-get install python3-tk```
45-
46-
## ▶️ How to Run
47-
48-
Clone the repository:
49-
52+
1️⃣ Clone the Repository
5053
```
51-
git clone https://github.com/mantrapatil03/python-beginner-friendly-projects/alarm-clock.git
52-
cd alarm-clock
54+
git clone https://github.com/mantrapatil03/python-beginner-friendly-projects.git
55+
cd python-beginner-friendly-projects/alarm-clock
5356
```
54-
(Optional) Create a virtual environment:
5557

58+
2️⃣ (Optional) Create a Virtual Environment
5659
```
5760
python -m venv venv
58-
source venv/bin/activate # On Linux/Mac
59-
venv\Scripts\activate # On Windows
61+
# Activate environment
62+
source venv/bin/activate # macOS/Linux
63+
venv\Scripts\activate # Windows
6064
```
61-
Install dependencies:
65+
66+
3️⃣ Install Dependencies
6267
```
6368
pip install -r requirements.txt
6469
```
65-
Run the program:
70+
4️⃣ Run the App
6671
```
6772
python alarm_clock.py
6873
```
69-
70-
71-
72-
## 📌 Future Improvements
73-
74-
🔊 Add alarm sound
75-
76-
⏰ Allow multiple alarms
77-
78-
🛌 Add snooze button
79-
80-
📜 Save alarm history
81-
82-
## 🏷 Author
83-
84-
Mantra Patil
74+
> Tip: Keep the app running in the background — it will alert you when the alarm time matches your system clock.
75+
76+
### Future Roadmap
77+
| Feature | Status | Description |
78+
| --------------------- | :-------: | ---------------------------------- |
79+
| Add alarm sound | Planned | Play audio when alarm triggers |
80+
| Multiple alarms | Planned | Support for more than one alarm |
81+
| Snooze option | Planned | Add “Remind me later” button |
82+
| Save alarm history | Planned | Keep a log of past alarms |
83+
| Custom themes | Planned | Light/Dark mode for Tkinter window |
84+
85+
### Contributing
86+
87+
Contributions are always welcome! 🚀
88+
- Fork this repository
89+
- Create a feature branch
90+
```
91+
git checkout -b feature/your-feature
92+
```
93+
- Commit your changes
94+
- Push to your fork
95+
- Open a Pull Request
96+
> Please follow clean code practices and PEP8 styling.
97+
98+
## Author
99+
**Mantra Patil**
85100
86101
💼 LinkedIn: https://www.linkedin.com/in/mantrapatil25
87102
88-
techmantrapatil@gmail.com
103+
✉️ techmantrapatil@gmail.com
104+
89105
106+
<h3 align="center">🎉 Thanks for checking out my Alarm Clock project! 🎉</h3> <p align="center"> If you found this helpful, please consider giving it a ⭐ on GitHub! <br><br> <img src="https://img.shields.io/badge/Keep%20Coding-Build%20with%20Python-orange?style=for-the-badge&logo=python"> </p>

0 commit comments

Comments
 (0)