diff --git a/README.md b/README.md index 2882294..3090cc3 100644 --- a/README.md +++ b/README.md @@ -7,100 +7,112 @@ Whenever you need to take notes, Nost helps you create files following the struc For example, if you add a note on the 6th of June 2025: ```txt - 2025/ - 06/ - 1/ - 03.md +2025/ + 06/ + 1/ + 06.md ``` -## Create a not +## Prerequisites +- [Rust](https://www.rust-lang.org/tools/install) (includes `cargo`) + +## Build the app + +```sh +cargo build --release ``` -cargo run not + +Optional: add an alias + +```sh +alias nost="RUST_LOG=warn /path/to/nost/target/release/nost" ``` -Or +## Configure the app +Copy `config.toml.dist` into `config.toml` and update the values. For example: + +```toml +not_path="/path/to/your/notes" +language="fr" ``` + +## Create a note + +```sh +cargo run new +``` + +Or + +```sh cargo run n ``` -## (WIP) Use not for working +## Work sessions (WIP) Begin a work session: -``` +```sh cargo run start-work ``` Or -``` +```sh cargo run sw ``` End a work session: -``` +```sh cargo run end-work ``` Or -``` +```sh cargo run ew ``` -For now, the data is only annotated, but these annotations are not yet used or processed. +Display work stats: -## Test - -Unit tests: - -``` -cargo test -``` - -Style: - -``` -cargo clippy --verbose -- -D warnings +```sh +cargo run work-stats ``` -Linter: +Or -``` -cargo fmt -- --check +```sh +cargo run ws ``` -## Configure the app +### Work plugin configuration -Copy `config.toml.dist` into `config.toml` and update the values. For example: +For computing work stats, add some env vars: -```toml -not_path="/home/gaetan/not" -language="fr" +```sh +export NOST_WORK_SALARY=0 +export NOST_WORK_CURRENCY=EUR ``` -## Build the app +## Development -Build the app with cargo +Unit tests: ```sh -cargo build --release +cargo test ``` -Optional: add an alias +Style: ```sh -alias nost="RUST_LOG=warn /your/path/for/nost-not/nost/target/release/nost" +cargo clippy --verbose -- -D warnings ``` -## Work plugin - -For computing work stats, add some env vars: +Linter: ```sh -export NOST_WORK_SALARY=0 -export NOST_WORK_CURRENCY=EUR +cargo fmt -- --check ```