Updated README.

Signed-off-by: Martin Schwenke <martin@meltin.net>

diff --git a/README b/README
index b351433b39058e6f7aed964213d35c93fe740f3e..1ecfaf16308726242ddc12883e280a7772205bc8 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,6 @@
+BASIC SETUP
+===========
+
 Before you start, make sure you have the latest version of
 autocluster. To download autocluster do this:
 
@@ -52,9 +55,8 @@ To setup a virtual cluster for SoFS with autocluster follow these steps:
     server in Mainz. See the FSCC wiki page on autocluster for
     details.
 
- 5) create a 'config' file in the autocluster directory. See
-    config.sample for an example, and see config.default for all
-    options that you can set.
+ 5) create a 'config' file in the autocluster directory.  See the
+    "CONFIGURATION" section below for more details.
 
  6) use "./autocluster create base" to create the base install image.
     The install will take about 10 to 15 minutes and you will see the
@@ -126,3 +128,47 @@ To setup a virtual cluster for SoFS with autocluster follow these steps:
      for your environment, but they should give you some hints on how
      to automate the final GUI stage of the installation of a SoFS
      cluster. 
+
+CONFIGURATION
+=============
+
+* See config.sample for an example of a configuration file.  Note that
+  all items in the sample file are commented out by default
+
+* Configuration options are defined in config.d/*.defconf.  All
+  configuration options have an equivalent command-line option.
+
+* Use "autocluster --help" to list all available command-line options
+  - all the items listed under "configuration options:" are the
+  equivalents of the settings for config files.
+
+* Run "autocluster --dump > config.foo" (or similar) to create a
+  config file containing the default values for all options that you
+  can set.  You can then delete all options for which you wish to keep
+  the default values and then modify the remaining ones, resulting in
+  a relatively small config file.
+
+* Use the --with-release option on the command-line or the
+  with_release function in a configuration file to get default values
+  for building virtual clusters for releases of particular "products".
+  Currently there are only release definitions for SoFS.  
+
+  For example, you can setup default values for SoFS-1.5.3 by running:
+
+    autocluster --with-release=SoFS-1.5.3 ...
+
+  Equivalently you can use the following syntax in a configuration
+  file:
+
+    with_release "SoFS-1.5.3"
+
+  The release definitions are stored in releases/*.release.  The
+  available releases are listed in the output of "autocluster --help".
+
+  NOTE: Occasionally you will need to consider the position of
+  with_release in your configuration.  If you want to override options
+  handled by a release definition then you will obviously need to set
+  them later in your configuration.  Some options will need to appear
+  before with_release so that they can be used within a release
+  definition - the most obvious one is the (rarely used) RHEL_ARCH
+  option, which is used in the default ISO setting for each release.