Skip to content

Latest commit

 

History

History
135 lines (82 loc) · 4.29 KB

README.md

File metadata and controls

135 lines (82 loc) · 4.29 KB
Raw

Pomodorolm
simple yet powerful time tracker



Screenshot of the app

🌟 Features

  • Customize round numbers, focus and break times
  • Auto-start round (optional)
  • Desktop notifications (optional)
  • Built-in themes
  • Custom themes
  • Color gradient depending on the remaining time
  • Tray icon with color gradient
  • Minimize to tray (optional)
  • Tick and end sounds (optional)
  • Multi-platform: Linux, Mac, Windows
  • Resizable window with automatic scaling
  • Always on top (optional)
  • Fully compatible with HiDPI/4K screens
  • Linux: Wayland and X11 support
  • Small: size < 4Mb (no electron, no node)
  • Custom sounds
  • Mini mode
  • Terminal User Interface
  • Mobile version

📘 Installation

Archlinux

yay -S pomodorolm-bin

Windows, Mac OS X, Debian, AppImage

Download the install file for your OS from the latest release on https://github.com/vjousse/pomodorolm/releases/

Flatpak

Get it on Flathub 
flatpak install flathub org.jousse.vincent.Pomodorolm
flatpak run org.jousse.vincent.Pomodorolm

Snap Store

Get it from the Snap Store

🎨 Themes

Pomodorolm provides many themes. It's also theme-able, allowing you to customize its appearance.

Screenshots of Pomotroid using various themes

Visit the theme documentation to view the full list of official themes and for instruction on creating your own.

💻 Dev

You will need to install rust first and https://github.com/astral-sh/uv for thepre-commit hooks and the release script.

Install pre-commit hooks

uv sync
uv run pre-commit install

Install node dependencies

npm ci

Running the app

npm run tauri dev

Running only the webapp

npm run dev

🔨 Build

If you're using Linux be sure to set the NO_STRIP env var to true (see tauri-apps/tauri#8929 ) if the build is failing.

NO_STRIP=true npm run tauri build -- --target x86_64-unknown-linux-gnu

If the build is still failing try to understand why using:

NO_STRIP=true npm run tauri build -- --target x86_64-unknown-linux-gnu --verbose

You can also try to build using docker-compose (to maximize compatibility, normal build is failing on Archlinux for example):

docker-compose run --rm --build build-linux

Build files will be placed in the target/ directory.

💀 Troubleshooting

Linux

Failed to create GBM buffer of size…

If you run into this error, it is likely because you're using nvidia drivers under Linux. They are several bug reports in Webkit, cf this issue for wails: wailsapp/wails#2977 (comment).

You can try to run pomodorolm using this command:

WEBKIT_DISABLE_DMABUF_RENDERER=1 pomodorolm

Thanks to @Bad3r for the bug report!

Error 71 (Protocol error) dispatching to Wayland display.

If you are using the flatpak, you can resolve this issue by using this command:

flatpak override --user --env=WEBKIT_DISABLE_DMABUF_RENDERER=1 org.jousse.vincent.Pomodorolm

This will set the environment variable for the flatpak, and you should be able to launch the application as normal from there on.

Windows

App starts and then closes immediately or doesn't start at all

Check that your antivirus (Windows defender or whatever antivirus you are using) doesn't report the app as a trojan. Unfortunately, there is a known issue tauri-apps/tauri#2486 on Tauri where a false positive is reported when executing apps generated with Tauri on Windows.

💯 Credits

Thanks to https://github.com/Splode/pomotroid for the original design and ideas.