2ndbeam/aliveline
1
1
Fork 0
Code Issues Pull requests Projects Releases 3 Packages Wiki Activity Actions

Updated README with images and some better text

Browse source
This commit is contained in:
Alexey 2025-11-26 17:41:52 +03:00
commit 18fc12c257
4 changed files with 14 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -5,7 +5,16 @@
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.
App can operate in Record and Review modes.
Record mode can allows you to update timeline by starting, stopping and chaining events:
![Record mode example](images/record.png)
By clicking on the timeline in Record mode you can hide controls to make app smaller and place it somewhere in the background:
![Minimized Aliveline example](images/record-background.png)
Review mode may be used to show some activity, tracker on another day:
![Review mode example](images/review.png)
Aliveline currently supports Linux only, but you can compile it to your platform
## Features
@ -19,7 +28,7 @@ start = 12:05:45
end = 13:00:11
finished = true
```
_Note: if event is not finished yet, it may have_ `end = 00:00:00`.
_Note: if event is not finished yet, it may have_ `end = start`.
## Building
Requirements:
@ -37,9 +46,9 @@ $ ./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.
See the example [config.toml](http://2ndbeam.ru/git/2ndbeam/aliveline/src/branch/master/config.toml) for default values.
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.