From c0bc91f6aec9c421252b02d76344b0b2fb4fb04d Mon Sep 17 00:00:00 2001
From: "Helmut K. C. Tessarek" <tessarek@evermeet.cx>
Date: Sun, 7 Jul 2019 21:01:34 -0400
Subject: [PATCH] add requirements to README.md

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index 37340a1..bc87d7e 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,28 @@ There's where script `jnclnst` comes to the rescue.
 
 The default locations for the config files are the path of the script and your home directory. These locations will be shown with the option `--help`.
 
+## Requirements
+
+bash version 4 is required for `jnclnst`. All scripts use getopt to parse the arguments. Unfortunately the getopt that comes with macOS is a useless piece of shit and can't be used in any useful manner.
+
+### macOS
+
+The best way to install proper versions of `bash` and `getopt` is to either use MacPorts or brew. Make sure they binaries are in the PATH before `/bin` and `/usr/bin`.
+
+#### MacPorts
+
+```
+sudo port install bash
+sudo port install getopt
+```
+
+#### brew
+
+```
+brew install bash
+brew install gnu-getopt
+```
+
 ## `jnrmor` - remove orphaned resources in Joplin
 
 ```