pihkaal/tlock
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: update README

Browse Source
This commit is contained in:
Stevan
2026-04-11 21:20:54 +02:00
parent 312b2f76e2
commit 667407e453
2 changed files with 15 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@@ -1,44 +1,28 @@
<h1 align="center"> <div align="center">
<br> <h1>tlock</h1>
<img src="https://i.imgur.com/EeTzHDR.png" width="200"> <img src="docs/demo.gif" alt="demo" />
<br> </div>
tlock
<br>
</h1>
<h4 align="center">Fully customizable terminal clock.</h4> Fully customizable clock for the terminal. You can change de colors, the format and you can even use multiples modes: clock, chronometer and timer.
<p align="center"> ## What it does
<a href="https://www.rust-lang.org">
<img src="https://img.shields.io/badge/rust-f54b00?style=for-the-badge&logo=rust&logoColor=white">
</a>
</p>
<p align="center" id="links"> - Clock mode, with customizable date display
<a href="#description">Description</a> • - Chronometer mode, with lap logging
<a href="#installation">Installation</a> • - Timer mode
<a href="#how-to-use">How to use</a> • - Debug mode (prints your configuration)
<a href="#configuration">Configuration</a> •
<a href="https://pihkaal.me">Visit it</a> •
<a href="#license">License</a>
</p>
<br> ## Next features
## Description - Customizable font
- Hot reloadable config
This is a fully customizable terminal clock written in Rust. You can change de colors, the format and you can even use multiples modes: clock, chronometer and timer.
<br>
## Installation ## Installation
```bash ```bash
$ cargo install --git https://github.com/pihkaal/tlock.git $ cargo install --git https://git.pihkaal.me/pihkaal/tlock.git
``` ```
<br>
## How to use ## How to use
```bash ```bash
@@ -58,8 +42,6 @@ $ tlock chrono
$ tlock timer 4h 12m 30s $ tlock timer 4h 12m 30s
``` ```
<br>
## Configuration ## Configuration
Configuration is stored under `~/.config/tlock/config`, it is generated by the program if it doesn't exist. Configuration is stored under `~/.config/tlock/config`, it is generated by the program if it doesn't exist.
@@ -72,13 +54,11 @@ $ tlock --regenerate-default
You can use multiple configuration files thanks to the `--config` flag: You can use multiple configuration files thanks to the `--config` flag:
```bash ```bash
$ tlock --config /path/to/my/config $ tlock --config /path/to/your/config
``` ```
The configuration itself contains comments to help you understand how to customize it. The configuration itself contains comments to help you understand how to customize it.
<br>
## License ## License
This project is <a href="https://opensource.org/licenses/MIT">MIT</a> licensed. This project is <a href="https://opensource.org/licenses/MIT">MIT</a> licensed.

BIN
docs/demo.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 320 KiB