]> us-delaporte.pagekite.me Git - minion.git/blobdiff - README.md
Add daily file helper
[minion.git] / README.md
index 1d234c5ea8f35f8cb886233139525c62db1419d0..4a9765e5d4901f99b055b8be6862860e9aaaa36b 100644 (file)
--- 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.
 
@@ -33,3 +34,9 @@ Run `mh` to see `help` further available commands.
 > `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.
+