diff --git a/README.md b/README.md index e84b991..60c28f0 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,34 @@ for a copy of the license, and see [TLDRLegal](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) for a short summary of the GPL. +
+ Local install +
+ +_Clone repository_ + + git clone https://github.com/ReflectsLight/al-quran.git + cd al-quran + +_Run dependency check_ + +The `bin/run-dependency-check` script will check that the required +dependencies are available: Ruby, NodeJS, nginx, et cetera. + + $ ./bin/run-dependency-check + +Assuming it was a success: + + found: ruby + found: bundle + found: node + found: npm + found: nginx + found: doas + +Otherwise, the dependencies that are missing will be listed. All +dependencies should be found before proceeding to the next step. +Credits
diff --git a/bin/run-dependency-check b/bin/run-dependency-check new file mode 100755 index 0000000..dba992e --- /dev/null +++ b/bin/run-dependency-check @@ -0,0 +1,18 @@ +#!/bin/sh + +require_dep() { + dep=$1 + which -s $dep + if [ $? -eq 0 ]; then + echo found: $dep + else + echo $dep is required, but not installed + fi +} + +require_dep ruby +require_dep bundle +require_dep node +require_dep npm +require_dep nginx +require_dep doas