Skip to content

BrenekH/beryl

Repository files navigation

Beryl

Simple timer with advanced features.

Installation

Windows

Head over to the latest release and download the installer.

If you want to use a standalone executable, grab the standalone zip file and run beryl.exe.

Linux

Download the tarball from the latest release page and extract using tar -xf Beryl-<version>-Linux-amd64.tar.gz replacing <version> with the downloaded version.

Usage

Beryl uses profiles to define the different stages for the timer to run, as well as any plugins to use and their configurations. A sample profile is available in this repository.

More information on profile files, check out the wiki.

Plugin Development

Head over to the wiki to learn more about how to create plugins for Beryl.

License

Beryl is licensed under the standard MIT license, a copy of which can be found in the LICENSE file.