X-Git-Url: https://apps.delaporte.us/gitweb/minion.git/blobdiff_plain/b7489d041b62e854e1d5495ec060c1785e15afcf..45f84a6379950909a6bbac4216b1540d2472826c:/README.md diff --git a/README.md b/README.md index 4b25fbc..1d234c5 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`. @@ -29,5 +28,8 @@ 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`.