Skip to content

Commit 2f4722d

Browse files
authored
Add README for Python Alarm Clock project
Added a comprehensive README for the Python Alarm Clock project, detailing features, installation instructions, and usage for both terminal and desktop GUI versions.
1 parent 9ca4384 commit 2f4722d

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

Alarm_Clock/Readme.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Python Alarm Clock ⏰
2+
3+
A simple Python alarm clock project that lets you set a countdown timer and plays a sound when the time is up.
4+
Built using **Python**, **pygame** for audio playback, and optionally extended to a **Tkinter desktop GUI app**.
5+
6+
---
7+
8+
## 📌 Features
9+
10+
✔ Set minutes and seconds for an alarm
11+
✔ Countdown timer displayed in terminal
12+
✔ Plays an audio file when alarm time is reached
13+
✔ Includes a desktop GUI version (Tkinter + pygame)
14+
✔ Works on Windows, macOS, and Linux (with pygame installed)
15+
16+
---
17+
18+
## 🛠 Installation
19+
20+
1. Clone this repository:
21+
```bash
22+
git clone https://github.com/Learnermeet/Python-Projects.git
23+
24+
2. Go to the project folder:
25+
- cd Python-Projects/Alarm_Clock
26+
27+
3. Install dependencies:
28+
- pip install pygame
29+
30+
---
31+
32+
🚀 Usage (Terminal Version)
33+
34+
1. Run the alarm script:
35+
- python alarm_clock.py
36+
2. Enter minutes and seconds:
37+
- Enter minutes: 0
38+
- Enter seconds: 30
39+
3. Wait for the countdown — the alarm will play when time is up.
40+
41+
---
42+
43+
🖥 Desktop GUI Version
44+
45+
If you want a graphical desktop app, use the included Tkinter GUI version:
46+
47+
- python alarm_gui.py
48+
49+
50+
👉 You’ll see a window where you can:
51+
52+
- Enter minutes & seconds
53+
54+
- Click Start to begin the countdown
55+
56+
- Click Stop to stop the alarm sound
57+
58+
---
59+
60+
Made with ❤️ by Learnermeet

0 commit comments

Comments
 (0)