diff --git a/README.md b/README.md index 4eb2c9b..1d12c48 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,30 @@ initialized with useful categories and saved views. To explore a populated file: cargo run -- demo.agnd --demo ``` +### Install for use from any directory + +From the Rogue Agenda source directory, install the release binary under your +user-local prefix: + +```sh +cargo install --path . --root "$HOME/.local" +``` + +This places the executable at `~/.local/bin/rogue-agenda`. Ensure +`~/.local/bin` is on your shell's `PATH`; for Bash or Zsh, add this line to the +appropriate startup file (`~/.bashrc` or `~/.zshrc`) if it is not already there: + +```sh +export PATH="$HOME/.local/bin:$PATH" +``` + +After opening a new shell, Rogue Agenda can be launched from anywhere: + +```sh +rogue-agenda notes.agnd +rogue-agenda demo.agnd --demo +``` + Noninteractive transfer commands are also available: ```sh