From 0c2a3d7e95962f20eaae51a209dfb5f6142ba69a Mon Sep 17 00:00:00 2001 From: 2ndbeam <2ndbeam@disroot.org> Date: Fri, 12 Sep 2025 15:21:41 +0300 Subject: [PATCH] Updated Readme again --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index cba76e1..7aaf937 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## About -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. Aliveline currently supports Linux. @@ -10,7 +10,7 @@ Aliveline currently supports Linux. ## Features ### Events -Events are main timeline building blocks. They have name, start and end. +Events are main timeline building blocks. They have name, start and end. Example of event in TOML format shown below: ```toml [[events]] @@ -19,7 +19,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 = 00:00:00`. ## Building Requirements: @@ -32,14 +32,14 @@ Run `cargo build --release` Just run `aliveline` by any preferred way. ## 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. You can configure these values: -- `log_path` - Type: `String` - Default: `logs` - Path to directory where logs are located. +- `log_path` + - Type: `String` + - Default: `logs` + Path to directory where logs are located. Path may be absolute or relative to config directory. ## Contribution