47 lines
1.1 KiB
Markdown
47 lines
1.1 KiB
Markdown
# Aliveline
|
|
|
|
## About
|
|
|
|
Aliveline is a small app made with Rust + Slint to track daily activity on a timeline.
|
|
All activity is saved into TOML logs, which are human readable/editable.
|
|
|
|
Aliveline currently supports Linux.
|
|
|
|
## Features
|
|
|
|
### Events
|
|
Events are main timeline building blocks. They have name, start and end.
|
|
Example of event in TOML format shown below:
|
|
```toml
|
|
[[events]]
|
|
name = "test"
|
|
start = 12:05:45
|
|
end = 13:00:11
|
|
finished = true
|
|
```
|
|
_Note: if event is not finished yet, it may have_ `end = 00:00:00`.
|
|
|
|
## Building
|
|
Requirements:
|
|
- Rust toolchain
|
|
|
|
Instructions:
|
|
Run `cargo build --release`
|
|
|
|
## Usage
|
|
|
|
Just run `aliveline` by any preferred way.
|
|
|
|
## Configuration
|
|
Aliveline tries to find config at `$XDG_CONFIG_DIR/aliveline/config.toml`.
|
|
If config isn't found, or `$XDG_CONFIG_DIR` is not set, Aliveline uses default values.
|
|
|
|
You can configure these values:
|
|
- `log_path`
|
|
- Type: `String`
|
|
- Default: `logs`
|
|
Path to directory where logs are located.
|
|
Path may be absolute or relative to config directory.
|
|
|
|
## Contribution
|
|
You can contribute to Aliveline by creating issue on this repository, then we'll discuss it.
|