README.md

   1
   2 ## Setup
   3
   4 1. Clone this repository.
   5 2. Add `minion/bin` to your `PATH`.
   6
   7 > `/usr/bin/bash` must be available, but does not need to be your default shell.
   8
   9 Create a folder `~/Journal`.
  10
  11 ## Basic Usage
  12
  13 Run `mn TOPIC DESCRIPTION` to start a new note file.
  14 A new file called `~/Jounal/2026/06-TOPIC-DESCRIPTION.md` will be opened in `vim`.
  15
  16 Run `ml TOPIC` to find a previous note file from this year.
  17 Run `mo TOPIC` to open all `.md` files in `Journal/2026` that contain `TOPIC` in the file name.
  18
  19 Use `mla` and `moa` variants to search all past Journal years.
  20
  21 Run `mh` to see `help` further available commands.
  22
  23 ## Recommended Usage
  24
  25 - For ongoing daily work, I keep one file each month with `mn daily` and `mo 06-daily`.
  26 - For a random meeting, use `mn meeting topic with some key terms` to create `~/Journal/2026/06-meeting-topic-with-some-key-terms.md`
  27 - When too many old files match my favorite search term, I move old ones into `~/Journal/archive/2026`, where `mla` and `moa` can still find them, in a pinch.
  28
  29 ## Customizing
  30
  31 `minion` will respect your `$EDITOR` setting. If `$EDITOR` is not set, `minion` will open files with `nano`.
  32
  33 > `minion` will *not* judge you if $EDITOR is not set to `vi`.
  34
  35 You could modify the scripts to change the journal home folder, which defaults to `$HOME/Journal`.