65 lines
1.3 KiB
Markdown
65 lines
1.3 KiB
Markdown
<div align="center">
|
|
<h1>tlock</h1>
|
|
<img src="docs/demo.gif" alt="demo" />
|
|
</div>
|
|
|
|
Fully customizable clock for the terminal. You can change the colors, the date and time format and you can even use multiples modes: clock, chronometer and timer.
|
|
|
|
## What it does
|
|
|
|
- Clock mode, with customizable date and time format
|
|
- Chronometer mode, with lap logging
|
|
- Timer mode
|
|
- Debug mode (prints your configuration)
|
|
|
|
## Next features
|
|
|
|
- Customizable font
|
|
- Hot reloadable config
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
$ cargo install --git https://git.pihkaal.me/pihkaal/tlock.git
|
|
```
|
|
|
|
## How to use
|
|
|
|
```bash
|
|
# Help
|
|
$ tlock --help
|
|
|
|
# Clock mode
|
|
$tlock
|
|
|
|
# Debug mode (print current configuration)
|
|
$ tlock debug
|
|
|
|
# Chronometer mode
|
|
$ tlock chrono
|
|
|
|
# Timer mode
|
|
$ tlock timer 4h 12m 30s
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Configuration is stored under `~/.config/tlock/config`, it is generated by the program if it doesn't exist.
|
|
You can regenerate this configuration at any time by running:
|
|
|
|
```bash
|
|
$ tlock --regenerate-default
|
|
```
|
|
|
|
You can use multiple configuration files thanks to the `--config` flag:
|
|
|
|
```bash
|
|
$ tlock --config /path/to/your/config
|
|
```
|
|
|
|
The configuration itself contains comments to help you understand how to customize it.
|
|
|
|
## License
|
|
|
|
This project is <a href="https://opensource.org/licenses/MIT">MIT</a> licensed.
|