Document spelling and HTML output

[minion.git] / README.md

diff --git a/README.md b/README.md
index 4b25fbc71d2cfa1f0a54f982c9583b281881cc59..1de0b00cb3f8416e43db95d9c82d01ac31e4ba38 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,10 @@
 
 ## Setup
 
 
 ## Setup
 

-Clone this repository.
-Add `minion/bin` to your `PATH`.
+1. Clone this repository.
+2. Add `minion/bin` to your `PATH`.

 
 

-Install `Fish` shell. 
-`Fish` must be available, but does not need to be your default shell.
+> `/usr/bin/bash` must be available, but does not need to be your default shell.

 
 Create a folder `~/Journal`.
 
 
 Create a folder `~/Journal`.
 


@@ -14,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 `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.
 
 
 Run `mh` to see `help` further available commands.
 


@@ -29,5 +29,14 @@ Run `mh` to see `help` further available commands.
 
 ## Customizing
 
 
 ## 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) 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.
+