diff --git a/README.md b/README.md index 563edcf..7f45f8f 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/images/record-background.png b/images/record-background.png new file mode 100644 index 0000000..05b8f37 Binary files /dev/null and b/images/record-background.png differ diff --git a/images/record.png b/images/record.png new file mode 100644 index 0000000..0a110a3 Binary files /dev/null and b/images/record.png differ diff --git a/images/review.png b/images/review.png new file mode 100644 index 0000000..1616c17 Binary files /dev/null and b/images/review.png differ