updated readme

Author: richarvey

README.md

@@ -8,7 +8,13 @@ c4-bootstrap is split into to major scripts and two directory structures.
 
 ##Requirements
 
-##Commands
+git-core
+bash
+Ubuntu
+
+##HOWTO c4-bootstrap
+
+##Commands in Detail
 
 ###bootstrap.sh
 bootstrap.sh allows you to quickly setup your system to specified environment, it will run pre.d and post.d scripts and also copy your directory structure from files to the root of the system. The follow explains how the script works.
@@ -35,9 +41,32 @@ This part of the script takes the contents of files/.... and copies them to / Th
 The final part of the script is post.d. This is called in the same way as pre.d and itterates through scripts/post.d/XXXX. In post.d you should run things that can only be done once the software is installed and the files are in place. An example of this would be _*a2ensite mysite.conf*_. Yet again these are bash scripts and will be run in numerical order.
 
 ###repack.sh
-whilst repack.sh allows you to commit local system changes back to a git repo in order repeat these changes on other servers.
+repack.sh allows you to commit local system changes back to a git repo in order repeat these changes on other servers.
+
+####Environment checks
+On running the repack.sh scrip the system checks for the system distro name and the version. The version number can be tweaked at the top of the file by altering the followinf variable:
+
+    supported_dist="Ubuntu"
+    supported_vers="10.04"
+
+This ensures that you are packaging for the same version as the bootstrap.sh
+
+####repack scripts
+The repack scripts live in the scripts/repack directory. Care should be taken when editing current scripts or adding to this directory.
+#####00-suckfiles.sh
+suck files enables repack.sh to pull back into the local directory all the changes you've made on the system in specified directories. in the example script it purely backs up /var/www. It handles /var/www in a special way to compensate for the fact you may have a lot of files in that location by tar.gz the directory and storing it in files/var/tmp/SiteContent.tgz this is also referenced by bootstrap.sh and is exploded in post.d/00-explode-files.sh
+
+Other directories specified are simply copied to files/....... verbatum.
+
+You can add extra locations to be backed up by modifying the array below in scripts/repack/00-suckfiles.sh:
+
+    working_dirs=( /var/www/ )
+
+the folowing would also copy the contents of /etc/apache2/
+
+    working_dirs=( /var/www/ /etc/apache2/ )
 
-###Files
+##Files
 
 The file structure of the system is kept within files, this should be treated as a mirror of your root / for example files/etc/nginx/nginx.conf after bootstrap.sh is run will map to /etc/nginx/nginx.conf