Skip to content

Commit 13a0c52

Browse files
committed
ReadMe added, to do list update
1 parent bca34bb commit 13a0c52

2 files changed

Lines changed: 39 additions & 1 deletion

File tree

Interval Timer Rust - To Do.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---------------- To Do ----------------
22

3-
3+
- add custom icon
44

55

66

ReadMe.txt

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Workout Timer
2+
3+
A simple interval timer for workouts, built with Rust and eframe.
4+
5+
## Features
6+
7+
* Customizable workout and rest intervals
8+
* Multiple rounds with automatic progression
9+
* Audio cues for workout and rest intervals
10+
* Simple and intuitive UI
11+
12+
## Usage
13+
14+
1. Run the program using `cargo run` (requires Rust and Cargo installed)
15+
2. Configure the workout and rest intervals, number of rounds, and audio cues as desired
16+
3. Click "Start" to begin the workout
17+
4. The program will automatically progress through the intervals and rounds, playing audio cues as needed
18+
19+
## Configuration
20+
21+
The program uses the following configuration options:
22+
23+
* `workout_duration`: the length of the workout interval in seconds (default: 60)
24+
* `rest_duration`: the length of the rest interval in seconds (default: 45)
25+
* `rounds`: the number of rounds to complete (default: 10)
26+
* `work_finish_audio`: the audio file to play at the end of the workout interval (default: `../work_finish.mp3`)
27+
* `rest_finish_audio`: the audio file to play at the end of the rest interval (default: `../rest_finish.mp3`)
28+
29+
## Dependencies
30+
31+
* Rust 1.51 or later
32+
* Cargo 1.51 or later
33+
* eframe 0.16 or later
34+
* rodio 0.16 or later
35+
36+
## License
37+
38+
This program is licensed under the MIT License. See `LICENSE` for details.

0 commit comments

Comments
 (0)