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

Updated README.md and LICENSE, added TODO

Browse source
This commit is contained in:
Alexey 2026-02-06 17:39:17 +03:00
commit 20a5f43d7f
3 changed files with 17 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -7,7 +7,7 @@ All activity is saved into TOML logs, which are human readable/editable.
App can operate in Record and Review modes.
Record mode can allows you to update timeline by starting, stopping and chaining events:
Record mode 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:
@ -35,6 +35,7 @@ _Note: if event is not finished yet, it may have_ `end = start`.
## Building
Requirements:
- Rust toolchain
- Slint dependencies (see [Platforms](https://docs.slint.dev/latest/docs/slint/guide/platforms/desktop/) and [Backends & Renderers](https://docs.slint.dev/latest/docs/slint/guide/backends-and-renderers/backends_and_renderers/))
Instructions:
Run `cargo build --release`
@ -47,10 +48,13 @@ $ ./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 defined in [config.toml](https://2ndbeam.ru/git/2ndbeam/aliveline/src/branch/master/config.toml).
Aliveline tries to find config at:
- `$XDG_CONFIG_DIR/aliveline/config.toml`
- `./config.toml` (relative to working directory)
If config isn't found, 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.
~~You can contribute to Aliveline by creating issue on this repository, then we'll discuss it.~~
I guess, it is not an option right now, since account creation is disabled on my Forgejo instance, but you may contact me via email: 2ndbeam@disroot.org