56 lines
1.7 KiB
Markdown
56 lines
1.7 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.
|
|
|
|
App can operate in Record and Review modes.
|
|
|
|
Record mode can allows you to update timeline by starting, stopping and chaining events:
|
|
|
|
|
|
By clicking on the timeline in Record mode you can hide controls to make app smaller and place it somewhere in the background:
|
|
|
|
|
|
Review mode may be used to show some activity, tracked on another day:
|
|
|
|
|
|
Aliveline currently supports Linux only, but you can compile it to your platform.
|
|
|
|
## 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 = start`.
|
|
|
|
## Building
|
|
Requirements:
|
|
- Rust toolchain
|
|
|
|
Instructions:
|
|
Run `cargo build --release`
|
|
|
|
## Usage
|
|
|
|
Just run `aliveline` by any preferred way, for example:
|
|
```
|
|
$ ./aliveline
|
|
```
|
|
|
|
## 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 defined in [config.toml](https://2ndbeam.ru/git/2ndbeam/aliveline/src/branch/master/config.toml).
|
|
Keep in mind that default paths are relative, and in this case logs will be written to and read from current working directory.
|
|
|
|
## Contribution
|
|
You can contribute to Aliveline by creating issue on this repository, then we'll discuss it.
|