Updated Readme again
This commit is contained in:
parent
6a1f371f1d
commit
0c2a3d7e95
1 changed files with 8 additions and 8 deletions
16
README.md
16
README.md
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
## About
|
## 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.
|
All activity is saved into TOML logs, which are human readable/editable.
|
||||||
|
|
||||||
Aliveline currently supports Linux.
|
Aliveline currently supports Linux.
|
||||||
|
|
@ -10,7 +10,7 @@ Aliveline currently supports Linux.
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
### Events
|
### 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:
|
Example of event in TOML format shown below:
|
||||||
```toml
|
```toml
|
||||||
[[events]]
|
[[events]]
|
||||||
|
|
@ -19,7 +19,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 = 00:00:00`.
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
Requirements:
|
Requirements:
|
||||||
|
|
@ -32,14 +32,14 @@ Run `cargo build --release`
|
||||||
Just run `aliveline` by any preferred way.
|
Just run `aliveline` by any preferred way.
|
||||||
|
|
||||||
## 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.
|
||||||
|
|
||||||
You can configure these values:
|
You can configure these values:
|
||||||
- `log_path`
|
- `log_path`
|
||||||
Type: `String`
|
- Type: `String`
|
||||||
Default: `logs`
|
- Default: `logs`
|
||||||
Path to directory where logs are located.
|
Path to directory where logs are located.
|
||||||
Path may be absolute or relative to config directory.
|
Path may be absolute or relative to config directory.
|
||||||
|
|
||||||
## Contribution
|
## Contribution
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue