Prepare v1.0.0 (#47)
* update README * update CHANGELOG * update demo * bump v1.0.0
This commit is contained in:
parent
9ea9f88266
commit
4ee5d7b4e9
13
CHANGELOG.md
13
CHANGELOG.md
@ -1,5 +1,15 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## v1.0.0 - 2025-01-10
|
||||||
|
|
||||||
|
Happy `v1.0.0` 🎉
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- (countdown) Mission Elapsed Time ([MET](https://en.wikipedia.org/wiki/Mission_Elapsed_Time)). [#45](https://github.com/sectore/timr-tui/pull/45), [#46](https://github.com/sectore/timr-tui/pull/46)
|
||||||
|
- (footer) Local time. Optional and with custom formats. [#42](https://github.com/sectore/timr-tui/pull/42), [#43](https://github.com/sectore/timr-tui/pull/43)
|
||||||
|
- (docs) More installation instructions: Cargo, AUR (Arch Linux) [#41](https://github.com/sectore/timr-tui/pull/41), pre-built release binaries (Linux, macOS, Windows) [#47](https://github.com/sectore/timr-tui/pull/47)
|
||||||
|
|
||||||
## v0.9.0 - 2025-01-03
|
## v0.9.0 - 2025-01-03
|
||||||
|
|
||||||
Initial version.
|
Initial version.
|
||||||
@ -8,5 +18,6 @@ Initial version.
|
|||||||
|
|
||||||
- Add `Pomodoro`, `Timer`, `Countdown`
|
- Add `Pomodoro`, `Timer`, `Countdown`
|
||||||
- Persist application state
|
- Persist application state
|
||||||
- Change styles
|
- Custom styles for digits
|
||||||
|
- Toggle deciseconds
|
||||||
- CLI
|
- CLI
|
||||||
|
|||||||
2
Cargo.lock
generated
2
Cargo.lock
generated
@ -1115,7 +1115,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "timr-tui"
|
name = "timr-tui"
|
||||||
version = "0.9.0"
|
version = "1.0.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"clap",
|
"clap",
|
||||||
"color-eyre",
|
"color-eyre",
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "timr-tui"
|
name = "timr-tui"
|
||||||
version = "0.9.0"
|
version = "1.0.0"
|
||||||
description = "TUI to organize your time: Pomodoro, Countdown, Timer."
|
description = "TUI to organize your time: Pomodoro, Countdown, Timer."
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
rust-version = "1.82.0"
|
rust-version = "1.82.0"
|
||||||
|
|||||||
36
README.md
36
README.md
@ -6,9 +6,9 @@ TUI to organize your time: Pomodoro, Countdown, Timer.
|
|||||||
- `[c]ountdown` Use it for your workout, yoga session, meditation, handstand or whatever.
|
- `[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](https://en.wikipedia.org/wiki/Pomodoro_Technique).
|
- `[p]omodoro` Organize your working time to be focused all the time by following the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique).
|
||||||
|
|
||||||
It's built with [`Ratatui`](https://ratatui.rs/) written in [Rust 🦀](https://www.rust-lang.org/).
|
Built with [Ratatui](https://ratatui.rs/) / [Rust 🦀](https://www.rust-lang.org/).
|
||||||
|
|
||||||
# Preview
|
# Features
|
||||||
|
|
||||||
_Side note:_ Theme colors depend on your terminal preferences.
|
_Side note:_ Theme colors depend on your terminal preferences.
|
||||||
|
|
||||||
@ -48,6 +48,18 @@ _Side note:_ Theme colors depend on your terminal preferences.
|
|||||||
<img alt="menu" src="demo/menu.gif" />
|
<img alt="menu" src="demo/menu.gif" />
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
## Local time
|
||||||
|
|
||||||
|
<a href="demo/local-time.gif">
|
||||||
|
<img alt="menu" src="demo/local-time.gif" />
|
||||||
|
</a>
|
||||||
|
|
||||||
|
## Mission Elapsed Time ([MET](https://en.wikipedia.org/wiki/Mission_Elapsed_Time))
|
||||||
|
|
||||||
|
<a href="demo/countdown-met.gif">
|
||||||
|
<img alt="menu" src="demo/countdown-met.gif" />
|
||||||
|
</a>
|
||||||
|
|
||||||
# CLI
|
# CLI
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
@ -70,25 +82,35 @@ Options:
|
|||||||
|
|
||||||
# Installation
|
# Installation
|
||||||
|
|
||||||
From [crates.io](https://crates.io/crates/timr-tui) run:
|
## Cargo
|
||||||
|
|
||||||
|
### From [crates.io](https://crates.io/crates/timr-tui)
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
cargo install timr-tui
|
cargo install timr-tui
|
||||||
```
|
```
|
||||||
|
|
||||||
Latest version from git repository:
|
### From GitHub repository
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
cargo install --git https://github.com/sectore/timr-tui
|
cargo install --git https://github.com/sectore/timr-tui
|
||||||
```
|
```
|
||||||
|
|
||||||
Arch Linux users can install [from the AUR](https://aur.archlinux.org/packages/timr/):
|
## Arch Linux
|
||||||
|
|
||||||
|
Install [from the AUR](https://aur.archlinux.org/packages/timr/):
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
paru -S timr
|
paru -S timr
|
||||||
```
|
```
|
||||||
|
|
||||||
# Build from source 🔧
|
|
||||||
|
## Release binaries
|
||||||
|
|
||||||
|
Pre-built artifacts are available to download from [latest GitHub release](https://github.com/sectore/timr-tui/releases).
|
||||||
|
|
||||||
|
|
||||||
|
# Development
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
@ -158,7 +180,7 @@ In `debug` mode only. Locations:
|
|||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Linux
|
# Linux
|
||||||
~/.local/state/timr/logs/app.log
|
~/.local/state/timr-tui/logs/app.log
|
||||||
# macOS
|
# macOS
|
||||||
/Users/{user}/Library/Application Support/timr-tui/logs/app.log
|
/Users/{user}/Library/Application Support/timr-tui/logs/app.log
|
||||||
# `Windows`
|
# `Windows`
|
||||||
|
|||||||
BIN
demo/countdown-met.gif
Normal file
BIN
demo/countdown-met.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 43 KiB |
@ -1,7 +1,7 @@
|
|||||||
Output demo/rocket-countdown.gif
|
Output demo/countdown-met.gif
|
||||||
|
|
||||||
# https://github.com/charmbracelet/vhs/blob/main/THEMES.md
|
# https://github.com/charmbracelet/vhs/blob/main/THEMES.md
|
||||||
Set Theme "AtomOneLight"
|
Set Theme "iceberg-light"
|
||||||
|
|
||||||
Set FontSize 14
|
Set FontSize 14
|
||||||
Set Width 800
|
Set Width 800
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 45 KiB |
BIN
demo/rocket-countdown_no-ds.gif
Normal file
BIN
demo/rocket-countdown_no-ds.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
7
justfile
7
justfile
@ -49,6 +49,11 @@ alias dc := demo-countdown
|
|||||||
demo-countdown:
|
demo-countdown:
|
||||||
vhs demo/countdown.tape
|
vhs demo/countdown.tape
|
||||||
|
|
||||||
|
alias dcm := demo-countdown-met
|
||||||
|
|
||||||
|
demo-countdown-met:
|
||||||
|
vhs demo/countdown-met.tape
|
||||||
|
|
||||||
alias ds := demo-style
|
alias ds := demo-style
|
||||||
|
|
||||||
demo-style:
|
demo-style:
|
||||||
@ -72,4 +77,4 @@ demo-local-time:
|
|||||||
alias drc := demo-rocket-countdown
|
alias drc := demo-rocket-countdown
|
||||||
|
|
||||||
demo-rocket-countdown:
|
demo-rocket-countdown:
|
||||||
vhs demo/rocket-countdown.tape
|
vhs demo/met.tape
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user