update documentation

This commit is contained in:
Brent Schroeter 2026-06-08 05:53:41 +00:00
parent 3a9607c4c9
commit 942336a77c
4 changed files with 52 additions and 1 deletions

2
.gitignore vendored
View file

@ -1,3 +1,5 @@
.DS_Store
# ---> Rust
# Generated by Cargo
# will have compiled files and executables

View file

@ -1 +1,50 @@
# Team Time Zones
A simple CLI app for displaying rich 24 hour time information for multiple
people or locations.
![Screenshot of a terminal window running the Team Time Zones TUI. The main
feature is a table displaying a list of locations across the top including
"Oakland", "UTC", and "Pacific Standard Time", each heading up a column of 24
cells displaying relative times throughout the day in the corresponding time
zone. Standard 9 to 5 working hours are highlighted in brighter text, and the
row representing the current hour is rendered in red. An input hint at the
bottom reads "Filter" with a slash and "Quit" with a Q.](./docs/screenshot.png)
## Install
```sh
# Install Rust toolchain
mise install
# Build executable
cargo build --release
# Move to path (substitute any destination in your $PATH)
cp target/release/ttz /usr/local/bin
```
## Run
With example config:
```sh
ttz -c ./ttz.example.kdl
```
Or create a `~/.config/ttz.kdl` to be loaded automatically. Refer to
`ttz --help` for more information.
## Configuration
TTZ uses the [KDL](https://kdl.dev/) format, with the following schema repeated
for each desired location:
```kdl
location "<DISPLAY NAME>" tz="<IANA TIME ZONE NAME>"
```
For valid time zone names, refer to the
[chrono_tz docs](https://docs.rs/chrono-tz/latest/chrono_tz/enum.Tz.html),
[Wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), or
the [IANA database](https://www.iana.org/time-zones).
Time zone names are case-sensitive.

BIN
docs/screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 339 KiB

View file

@ -1,4 +1,4 @@
location Oakland tz="America/Los_Angeles"
location UTC tz="UTC"
// Unclear why this is +8 and not -8.
// Etc/GMT* have their signs intentionally reversed for POSIX compliance.
location "Pacific Standard Time" tz="Etc/GMT+8"