X-Git-Url: https://apps.delaporte.us/gitweb/minion.git/blobdiff_plain/7c8fa9d42f5a37ccd09d509585e983472ba8c5fb..97a73fbd7911229147e1c5f19bc9dbd1734ae67d:/README.md diff --git a/README.md b/README.md index 34e7063..4a9765e 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,11 @@ Create a folder `~/Journal`. Run `mn TOPIC DESCRIPTION` to start a new note file. A new file called `~/Jounal/2026/06-TOPIC-DESCRIPTION.md` will be opened in `vim`. -Run `ml TOPIC` to find a previous note file from this year. -Run `mo TOPIC` to open all `.md` files in `Journal/2026` that contain `TOPIC` in the file name. +Run `ml TOPIC` to list all notes with `TOPIC` in the file name, under `~/Journal/2026`. -Use `mla` and `moa` variants to search all past Journal years. +Run `mo TOPIC` to open all `.md` files in `~/Journal/2026` that contain `TOPIC` in the file name. + +Use `mla` and `moa` variants to search all year folders in `~/Journal/`. (`~/Journal/2025`, `~/Journal/2026`, etc.) Run `mh` to see `help` further available commands. @@ -28,5 +29,14 @@ Run `mh` to see `help` further available commands. ## Customizing -You can modify the scripts to change the editor, and journal home folder. -I may make use environment variables at some point to make this easier, but I haven't yet. +`minion` will respect your `$EDITOR` setting. If `$EDITOR` is not set, `minion` will open files with `nano`. + +> `minion` will *not* judge you if $EDITOR is not set to `vi`. + +You could modify the scripts to change the journal home folder, which defaults to `$HOME/Journal`. + +## Advanced Features + +- To use `mp` to open files as HTML, install [mdtohtml](https://github.com/sgaunet/mdtohtml/releases) and ensure it is on your PATH. +- To use `ms` to run an interactive spelling check on all matching files, install [aspell](https://manpages.debian.org/trixie/aspell/aspell.1.en.html) and ensure it is on your PATH. +