X-Git-Url: https://us-delaporte.pagekite.me/gitweb/minion.git/blobdiff_plain/51994da1199b794861cf371ab56d7d7a3d508c07..685d4c5f044d81aa8444639cbf43011b1c527fb5:/README.md diff --git a/README.md b/README.md index e06bf30..e9cfaa8 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,20 @@ Use `mla` and `moa` variants to search all year folders in `~/Journal/`. (`~/Jou Run `mh` to see `help` further available commands. +## Common Commands + +Tracking daily work + +`daily` - opens MM-daily.md to track things I want to check on each day. + +Organizing past notes files + +`ml 02-` list all journal files from February of this year. +`mma 02-` archive all journal files from February of this year. +`ml quantum` list all journal files with `quantum` in the name, this year. +`mg quantum pqc` gather the content of all files with `quantum` or `pqc` in the name into a new `09-quantum.md` file, and archive the previous files into the `archive-2026` folder. + + ## Recommended Usage - For ongoing daily work, I keep one file each month with `mn daily` and `mo 06-daily`. @@ -34,3 +48,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. +