diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..dfab25c --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Beefsteak: A Simple Pomodoro Timer +Sometimes, there are things that you really need to get done. To help you grit your teeth and get it done, the *Pomodoro Technique* helps. By breaking time into blocks of work and rest, you are able to consistantly work for long periods of time. `beefsteak` aims to be a simple to use pomodoro timer written in C. + +By default, the work time is 50 minutes. The break time is 10 minutes. With a default session amount of 3, that adds up to 3 hours of solid work. + +`beefsteak` is free/libre software. It is released under the GPLv3 license, which is found in the `LICENSE` file. +# Requirements +- `libnotify` (To send notifcations) + - Some sort of notification program (Ex. `dunst`) +# Install +`sudo make install` + +For me personally, I choose to alias `beefsteak` to `bfs` in my `~/.bashrc`. +# Uninstall +`sudo make uninstall` |