diff --git a/LICENSE b/LICENSE index ede73d8..4c79585 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2025 Alexey Mirenkov +Copyright (c) 2025-2026 Alexey Mirenkov <2ndbeam@disroot.org> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 31f383f..552bbf9 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/TODO b/TODO new file mode 100644 index 0000000..d890fbd --- /dev/null +++ b/TODO @@ -0,0 +1,7 @@ +feat: + implement instants + command line interface + proper config path handling + more coloring options +refactor: + remove weird RawConfig struct