From: W. Trevor King Date: Fri, 11 Jan 2013 18:32:58 +0000 (-0500) Subject: setup/README.md: Install-testing script care and feeding X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=092af4e1582893c9cacdbcfaa27a87fc5b92ca76;p=swc-workshop.git setup/README.md: Install-testing script care and feeding --- diff --git a/setup/README.md b/setup/README.md new file mode 100644 index 0000000..aba09a9 --- /dev/null +++ b/setup/README.md @@ -0,0 +1,58 @@ +Students +======== + +This directory contains scripts for testing your machine to make sure +you have the software you'll need for your boot camp installed. See +the comments at the head of each script for more details, but you'll +basically want to see something like: + + $ python swc-installation-test-1.py + Passed + $ python swc-installation-test-2.py + check virtual-shell... pass + … + Successes: + + virtual-shell Bourne Again Shell (bash) 4.2.37 + … + +If you see something like: + + $ python swc-installation-test-2.py + check virtual-shell... fail + … + For instructings on installing a particular package, + see the failure message for that package printed above. + … + +follow the suggestions to try and install any missing software. + +Instructors +=========== + +`swc-installation-test-1.py` is pretty simple, and just checks that +the students have a recent enough version of Python installed that +they'll be able to parse `swc-installation-test-2.py`. The latter +checks for a list of dependencies and prints error messages if a +package is not installed, or if the installed version is not current +enough. By default, the script checks for pretty much anything that +has ever been used at a Software Carpentry boot camp, which is +probably not what you want for your particular boot camp. + +Before your boot camp, you should go through +`swc-installation-test-2.py` and comment any dependencies you don't +need out of the `CHECKS` list. You might also want to skim through +the minimum version numbers listed where particular dependencies are +defined (e.g. `('git', 'Git', (1, 7, 0))`). For the most part, fairly +conservative values have been selected, so students with modern +machines should be fine. If your boot camp has stricter version +requirements, feel free to bump them accordingly. + +Similarly, the virtual dependencies can be satisfied by any of several +packages. If you don't want to support a particular package (e.g. if +you have no Emacs experience and don't want to be responsible for +students who show up with Emacs as their only editor), you can comment +out that particular `or_dependency`. + +Finally, don't forget to post your modified scripts somewhere where +your students can download them!