Skip to content

Commit 9cdacd4

Browse files
authored
Update README.md
1 parent 15475f4 commit 9cdacd4

File tree

1 file changed

+2
-8
lines changed

1 file changed

+2
-8
lines changed

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,6 @@
33
A simple and effective reminder tool built with Python that prompts users to take breaks at regular intervals. When it's time for a break, `breakReminder` displays a full-screen window and, optionally, plays a reminder sound.
44

55
### Usage
6-
- **In Windows**, just download the `.zip` file, extract it, and run `.exe` file.
7-
- **In any other environment where Python is installed**, run the script from your terminal `python break_reminder.py` (Requires Python 3.6 or later and Pygame).
6+
- Run the script from your terminal `python break_reminder.py` (Requires Python 3.6 or later and Pygame).
87

9-
You can modify the `config.json` file to customize the interval between reminders, the music file path, and toggle music playback on or off. If you place the mp3 file next to the script or executable, all you need to do is enter the name of the music file (including the `.mp3` extension) in the musicPath parameter of the config file.
10-
11-
12-
## Acknowledgments
13-
14-
- Special thanks to OpenAI ChatGPT for assisting with the development of this script and providing code examples.
8+
You can modify the `config.json` file to customize the interval between reminders.

0 commit comments

Comments
 (0)