Updated README with images and some better text
This commit is contained in:
parent
a74857b49b
commit
18fc12c257
4 changed files with 14 additions and 5 deletions
19
README.md
19
README.md
|
|
@ -5,7 +5,16 @@
|
||||||
Aliveline is a small app made with Rust + Slint to track daily activity on a timeline.
|
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.
|
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:
|
||||||
|

|
||||||
|
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, tracker on another day:
|
||||||
|

|
||||||
|
|
||||||
|
Aliveline currently supports Linux only, but you can compile it to your platform
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
|
@ -19,7 +28,7 @@ start = 12:05:45
|
||||||
end = 13:00:11
|
end = 13:00:11
|
||||||
finished = true
|
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
|
## Building
|
||||||
Requirements:
|
Requirements:
|
||||||
|
|
@ -37,9 +46,9 @@ $ ./aliveline
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
Aliveline tries to find config at `$XDG_CONFIG_DIR/aliveline/config.toml`.
|
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.
|
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).
|
||||||
See the example [config.toml](http://2ndbeam.ru/git/2ndbeam/aliveline/src/branch/master/config.toml) for default values.
|
Keep in mind that default paths are relative, and in this case logs will be written to and read from current working directory.
|
||||||
|
|
||||||
## Contribution
|
## Contribution
|
||||||
You can contribute to Aliveline by creating issue on this repository, then we'll discuss it.
|
You can contribute to Aliveline by creating issue on this repository, then we'll discuss it.
|
||||||
|
|
|
||||||
BIN
images/record-background.png
Normal file
BIN
images/record-background.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 115 KiB |
BIN
images/record.png
Normal file
BIN
images/record.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
BIN
images/review.png
Normal file
BIN
images/review.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
Loading…
Add table
Add a link
Reference in a new issue