fix: use data_local_dir if state_dir not found (#31 )

Fixes #30

2024-12-30 19:56:27 +01:00

3.4 KiB

Raw Blame History

tim:r

Pronounced /ˈtʌɪmə/ or /ˈtaɪmər/.

tim:r is a TUI app to help organize one of the most important thing you might have in live: time!

[t]imer Check the time on anything you are you doing.
[c]ountdown Use it for your workout, yoga session, meditation, handstand or whatever.
[p]omodoro Organize your working time to be focused all the time by following the Pomodoro Technique.

It's built with Ratatui written in Rust 🦀.

Preview

Side note: Theme colors depend on your terminal preferences.

Pomodoro

Timer

Countdown

Change style

Toggle deciseconds

Args ⚙️

Usage: timr [OPTIONS]

Options:
  -c, --countdown <COUNTDOWN>  Countdown time to start from. Formats: 'ss', 'mm:ss', or 'hh:mm:ss' [default: 10:00]
  -w, --work <WORK>            Work time to count down from. Formats: 'ss', 'mm:ss', or 'hh:mm:ss' [default: 25:00]
  -p, --pause <PAUSE>          Pause time to count down from. Formats: 'ss', 'mm:ss', or 'hh:mm:ss' [default: 5:00]
  -d, --decis                  Wether to show deciseconds or not. [default: false]
  -m, --mode <MODE>            Mode to start with. [possible values: countdown, timer, pomodoro] [default: timer]
  -s, --style <STYLE>          Style to display time with. [possible values: full, light, medium, dark, thick, cross, braille] [default: full]
  -r, --reset                  Reset stored values to default.
  -h, --help                   Print help

Build from source 🔧

Requirements

cd into root directory.

If you have direnv installed, run direnv allow once to install dependencies. In other case run nix develop.

Non Nix users

Commands

just --list

Available recipes:
    build   # build app
    b       # alias for `build`
    default
    format  # format files
    f       # alias for `format`
    lint    # lint
    l       # alias for `lint`
    run     # run app
    r       # alias for `run`
    test    # run tests
    t       # alias for `test`

Build

Linux

nix build

Windows (cross-compilation)

nix build .#windows

Misc.

Persistant app state

Stored on file system.

Linux

cat ~/.local/state/timr/data/timr.data

macOS

cat /Users/{user}/Library/Application Support/timr/data/timr.data

Windows

cat C:/Users/{user}/AppData/Local/timr/data/timr.data

Logs

In debug mode only.

Linux

tail -f ~/.local/state/timr/logs/timr.log

macOS

tail -f /Users/{user}/Library/Application Support/timr/logs/timr.log

Windows

tail -f C:/Users/{user}/AppData/Local/timr/logs/timr.log

3.4 KiB Raw Blame History Unescape Escape