aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 2867a94455da41cfecf9ff3e72819524f0c38a93 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# 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
```bash
git clone https://git.foswret.com/beefsteak
cd beefsteak
sudo make install
```

For me personally, I choose to alias `beefsteak` to `bfs` in my `~/.bashrc`.
```
# ~/.bashrc
alias bfs='beefsteak'
```
# Uninstall
`sudo make uninstall`