> [!warning]
> This is a work in progress and not stable.

# Focus

Simple Pomodoro timer.

![Focus](https://codeberg.org/vyn/focus/raw/branch/main/images/presentation-1.png)

## Build from source

### Requirements

- GCC >= 14.2.1
- CMake >= 3.30.2
- Ninja (or Make but you will need to adapt the commands)
- Git

You can provide a custom script to execute when the timer ends, the usual usage is to display a
notification and play a sound, so if you don't provide your own script you also need:

- notify-send (notification's visual)
- gst-play-1.0 (notification's sound)

### Steps

Fetch and setup the repository:
```
git clone https://codeberg.org/vyn/focus.git
cd focus
git submodule update --init --recursive
```

To build:
```
cmake -DCMAKE_BUILD_TYPE=Release -S . -B ./build -G Ninja
cd build
ninja
```
Then you should have a `focus` executable in the `build` directory you are currently in.

## Contributing

Feel free to make suggestions and report issues, but I do **not** accept contributions (pull requests).

## License

Copyright (C) Vyn 2024

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, under version 3 of the License only.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program in the LICENSE file.
If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>.