An open API service indexing awesome lists of open source software.

https://github.com/cosmic-utils/cosmic-ext-applet-pomodoro

A pomodoro timer applet for the COSMIC desktop
https://github.com/cosmic-utils/cosmic-ext-applet-pomodoro

Last synced: about 2 months ago
JSON representation

A pomodoro timer applet for the COSMIC desktop

Awesome Lists containing this project

README

          

# Pomodoro Timer

A pomodoro timer applet for the COSMIC™ desktop. Sits in the panel and provides work/break interval tracking with configurable durations.

> This project is created and maintained by Ben Gubler ([@bgub](https://github.com/bgub)). It is not affiliated with or endorsed by System76.

![Screenshot](screenshot.png)

## Installation

### Build from source

Requires a [Rust toolchain][rustup], [just][just], and the standard COSMIC™ build dependencies (`pkg-config`, plus dev libraries for dbus, wayland, xkbcommon, etc. — the same packages needed to build any COSMIC™ applet).

```sh
just install # system-wide (/usr), needs sudo
just install-user # user-local (~/.local), no root needed
```

Then add the applet to a panel in **Settings > Desktop > Panel**.

### NixOS

NixOS users should use the [Flatpak package](https://github.com/pop-os/cosmic-flatpak/pull/116) for now.

### Flatpak

A [cosmic-flatpak package](https://github.com/pop-os/cosmic-flatpak/pull/116) is in review.

## Translators

[Fluent][fluent] is used for localization of the software. Fluent's translation files are found in the [i18n directory](./i18n). New translations may copy the [English (en) localization](./i18n/en) of the project, rename `en` to the desired [ISO 639-1 language code][iso-codes], and then translations can be provided for each [message identifier][fluent-guide]. If no translation is necessary, the message may be omitted.

## Packaging

If packaging for a Linux distribution, vendor dependencies locally with the `vendor` rule, and build with the vendored sources using the `build-vendored` rule. When installing files, use the `rootdir` and `prefix` variables to change installation paths.

```sh
just vendor
just build-vendored
just rootdir=debian/cosmic-ext-applet-pomodoro prefix=/usr install
```

It is recommended to build a source tarball with the vendored dependencies, which can typically be done by running `just vendor` on the host system before it enters the build environment.

## Developers

Developers should install [rustup][rustup] and configure their editor to use [rust-analyzer][rust-analyzer].

[fluent]: https://projectfluent.org/
[fluent-guide]: https://projectfluent.org/fluent/guide/hello.html
[iso-codes]: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
[just]: https://github.com/casey/just
[rustup]: https://rustup.rs/
[rust-analyzer]: https://rust-analyzer.github.io/