~install.sh -> Install.org

An org file is better suited for this kinda job: literate, modular and
easy to explain my decisions. Furthermore, I can make components for
this installation easily just by making sections

2 files changed, 56 insertions, 24 deletions

diff --git a/Install.org b/Install.org
new file mode 100644
index 0000000..590852a
--- /dev/null
+++ b/Install.org
@@ -0,0 +1,56 @@
+#+TITLE: Install
+
+* Stow all modules
+Basically get all folders excluding the '.git' and '.' folder, then just stow them.
+#+BEGIN_SRC sh
+folders=`find . -maxdepth 1 -type 'd' -not -name '.git' -not -name '.'`;
+
+# Symlink profiles
+for pkg in $folders; do
+	echo "Stowing " $pkg;
+	stow $pkg
+done
+#+END_SRC
+* Generate user directories
+This makes some useful directories that are used by the system and/or by me. I
+split these into two sections so you can execute the ones you think are useful.
+** System folders
+#+BEGIN_SRC sh
+mkdir ~/.local;
+mkdir ~/.local/src;
+mkdir ~/.local/bin;
+
+mkdir ~/.config;
+#+END_SRC
+** User folders
+Firstly the essentials for a good user experience™
+#+BEGIN_SRC sh
+mkdir ~/Downloads ~/Pictures ~/Music;
+#+END_SRC
+
+Then generate the other stuff that I use (mostly).
+#+BEGIN_SRC sh
+mkdir ~/Text;
+mkdir ~/School;
+mkdir ~/Code;
+mkdir ~/Code/Learning;
+mkdir ~/Code/Projects;
+mkdir ~/Code/Templates;
+#+END_SRC
+* Clone templates
+These are templates coded by me (MIT licensed) which are basically boilerplate
+helpers for differing languages. They allow me to quickly start coding up
+projects as they remove the hassle of setting the build system and source
+directories up manually.
+
+They're cloned into =~/Code/Templates= not only so you can hack on them as you
+wish but also so you can generate templates even when offline just by copying
+the template you want and removing/replacing the '.git' directory in it.
+
+#+BEGIN_SRC sh
+declare -a templates=("CTemplate" "CPPTemplate" "PythonTemplate"
+					  "NodeTemplate" "ArduinoTemplate");
+for template in ${templates[@]}; do
+	git clone https://github.com/odavep/$template ~/Code/Templates/$template;
+done
+#+END_SRC
diff --git a/install.sh b/install.sh
deleted file mode 100644
index 52a7940..0000000
--- a/install.sh
+++ /dev/null
@@ -1,24 +0,0 @@
-#!/bin/bash
-
-folders=`find . -maxdepth 1 -type 'd' -not -name '.git' -not -name '.'`;
-
-# Symlink profiles
-for pkg in $folders; do
-	echo "Stowing " $pkg;
-	stow $pkg
-done
-
-# Generate folders
-mkdir ~/Text;
-mkdir ~/Code;
-mkdir ~/Code/Learning;
-mkdir ~/Code/Projects;
-mkdir ~/Code/Templates;
-mkdir ~/School;
-
-# get templates
-declare -a templates=("CTemplate" "CPPTemplate" "PythonTemplate"
-					  "NodeTemplate" "ArduinoTemplate");
-for template in ${templates[@]}; do
-	git clone https://github.com/odavep/$template ~/Code/Templates/$template;
-done