https://github.com/brenekh/beryl

Simple timer with advanced features.
https://github.com/brenekh/beryl

electron-app inno-setup plugins timer timing typescript

Last synced: 9 days ago
JSON representation

Simple timer with advanced features.

• Host: GitHub
• URL: https://github.com/brenekh/beryl
• Owner: BrenekH
• License: mit
• Created: 2021-05-19T18:40:29.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-06-19T21:43:52.000Z (7 months ago)
• Last Synced: 2024-06-20T10:58:25.865Z (7 months ago)
• Topics: electron-app, inno-setup, plugins, timer, timing, typescript
• Language: TypeScript
• Homepage:
• Size: 673 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Beryl

Simple timer with advanced features.

## Installation

### Windows

Head over to the [latest release](https://github.com/BrenekH/beryl/releases/latest) 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](https://github.com/BrenekH/beryl/releases/latest) and extract using `tar -xf Beryl--Linux-amd64.tar.gz` replacing `` 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](https://github.com/BrenekH/beryl/tree/master/sample_profile.json) is available in this repository.

More information on profile files, check out the [wiki](https://github.com/BrenekH/beryl/wiki/Profiles).

## Plugin Development

Head over to the [wiki](https://github.com/BrenekH/beryl/wiki/Plugins) 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](https://github.com/BrenekH/beryl/tree/master/LICENSE).