From 342e475ac91b77b0578c02dc8a187690571260b7 Mon Sep 17 00:00:00 2001 From: Ryan Greenup Date: Mon, 13 Jul 2020 00:11:59 +1000 Subject: [PATCH] Added Installation Instructions --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 1d57478..bfb7687 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # cadmus Shell Scripts to Facilitate Effective Note Taking + +## Installation + +```bash +cd ~/DotFiles + +if [[ -d ".git" ]]; then + echo "Adding Submodule"; + git submodule add https://github.com/RyanGreenup/cadmus +else echo "Cloning Repository"; + git clone add https://github.com/RyanGreenup/cadmus +fi + +command -v foo >/dev/null 2>&1 || { echo >&2 "I require foo but it's not installed. Aborting."; exit 1; } +stow -t $HOME -S cadmus +```