X-Git-Url: https://us-delaporte.pagekite.me/gitweb/minion.git/blobdiff_plain/b7489d041b62e854e1d5495ec060c1785e15afcf..c7038ec53ac27a936d69d3d0aa3e1325a424ecb4:/README.md diff --git a/README.md b/README.md index 4b25fbc..e9cfaa8 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ ## 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`. @@ -14,13 +13,28 @@ 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. +## 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`. @@ -29,5 +43,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. +