Set admin e-mail address properly on MediaWiki >= 1.18.0

[wizard.git] / README

diff --git a/README b/README
index d411e9d86353002d534573227c4b7011796bf9db..5d0b88d39507c0d7aca33e20eaacc6d7e815eb14 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,10 @@
-Wizard is the new autoinstaller management system for
-scripts.mit.edu.  This is a developer oriented introduction,
-and will get placed in doc/ soon.
+Wizard Autoinstall
+==================
+
+Wizard is a next-generation autoinstall management system with
+an eye towards flexibility and scalability.  It is licensed
+under the MIT license (you can view the license contents in
+LICENSE).
 
 
 Compatibility
@@ -34,7 +38,7 @@ all error classes at the bottom.
 Notes for repository creation
 -----------------------------
 
-See TODO for full instructions.
+See documentation for full instructions.
 
 - You are not going to be able to doctor a perfect repository
   from scratch.
@@ -63,7 +67,7 @@ See TODO for full instructions.
     - If it's a PHP application, it's probably inserting a php.ini
       file and creating symlinks to it.  Be sure to replace the
       appropriate values with placeholders WIZARD_SESSIONNAME
-      and WIZARD_TMPDIR
+      and WIZARD_TMPDIR (Scripts)
 
     - You will probably need to generate relevant configuration
       files for each version using 'wizard prepare-config'
@@ -80,6 +84,10 @@ Design decisions
   if we continued going, we will keep going, and let the maintainer
   deal later on with the errors en masse.
 
+  If the error is due to an error in our toolchain (and thus
+  many installs can be fixed by fixing our end), we want to
+  be able to re-run the mass tool with minimal fuss.
+
 - We use the Google Python style guide.  See:
     http://code.google.com/p/soc/wiki/PythonStyleGuide
   However, we use 4-space indents, not 2-space indents.