diff options
| author |  Silas Bartha <[email protected]> | 2023-12-22 13:28:34 -0500 |
|---|---|---|
| committer | Silas Bartha <[email protected]> | 2023-12-22 13:28:34 -0500 |
| commit | 7426dedaf1ffe142ca718533083a5eb51109ca7e (patch) | |
| tree | e557af8027d4a7609bfc1a66c7e63027852ed996 /README.md | |
| parent | 901d27db601a27d580c1f2f8d4b3d3361f60cc2e (diff) | |
Updated readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
@@ -2,3 +2,23 @@ This program provides a simple pomodoro daemon for linux. +## Features +- D-Bus interface for pomodoro functionality +- Configurable: + - Duration of work period, short breaks, and long breaks + - Number of iterations before long breaks + - Enable/disable notifications + +## Installation +### From Source +```sh +cargo install --path . +``` + +## Usage +To use the program, simply run `pomd` wherever you run startup programs. It requires a D-Bus session, so make sure that you use xinit/startx you will need to start the program after launching your session. + +The [pomc](https://github.com/exvacuum/pomc) client application can be used to interact with the daemon, or you can interact with the interface in your own scripts/programs. + +## Configuration +The first time the program is run, a config.toml file will be created in your configuration directory (this is handled by the [confy](https://crates.io/crates/confy) crate, and is probably `$XDG_CONFIG_HOME/config.toml`). The keys are relatively self-explanatory, and all of the "duration" values should be specified in seconds. |