build/lib/gant/README_Install.txt

   1 Gant -- A Groovy way of scripting Ant tasks.
   2
   3 This is Gant, a Groovy way of working with Ant tasks -- no more XML :-)
   4
   5 The method of installation depends on whether you have downloaded a tarball or
   6 zipfile distribution, or you have a Bazaar branch or a Subversion store
   7 checkout (or even a Git clone of the Subversion repository).
   8
   9 Distribution
  10 ------------
  11
  12 The Gant distributions contain a ready-made install directory hierarchy.
  13 Untar the tarball or unzip the zipfile to the location where you want the Gant
  14 installation to reside.  A directory with the name structured
  15 gant-<gant-version-number> will be created in the location specified for the
  16 untar or unzip.
  17
  18 There are a number of distinct distributions:
  19
  20           1.  Requires a separate Groovy installation.  There are builds:
  21                 a.  compiled against Groovy 1.5.8;
  22                 b.  compiled against Groovy 1.6.3; and
  23                 c.  compiled against Groovy Trunk (1.7-beta-1-SNAPSHOT).
  24
  25             2.  Self-contained, includes all dependent jars.
  26
  27 You might like to set up an environment variable GANT_HOME set to the
  28 directory created by the untar or unzip, though this is not essential, it is
  29 just an efficiency.
  30
  31 The script $GANT_HOME/bin/gant for systems with a Posix shell, or
  32 $GANT_HOME/bin/gant.bat on Windows is the mechanism for launching a Gant run.
  33
  34 Using a Bazaar Branch or a Checkout of the Subversion Repository
  35 ----------------------------------------------------------------
  36
  37 You first need to get a source tree.  If you want to use a Bazaar branch as
  38 your source (Bazaar is the VCS used for the master source of Gant) then:
  39
  40     bzr branch lp:gant
  41
  42 this is a mirror of the master Bazaar branch, as indeed is the Subversion
  43 repository at Codehaus).  The alternative is to get the Subversion repository
  44 using one of the following:
  45
  46    bzr branch http://svn.codehaus.org/gant/gant/trunk Gant_Trunk
  47    svn co http://svn.codehaus.org/gant/gant/trunk Gant_Trunk
  48    git clone http://svn.codehaus.org/gant/gant/trunk Gant_Trunk
  49
  50 Once you have a Gant source tree, you will need to create a file called
  51 local.build.properties at the top level of that tree containing a definition
  52 of the property installDirectory.  This property defines the directory of the
  53 installation (NB not the parent).  An example definition:
  54
  55   installDirectory = ${user.home}/lib/JavaPackages/gant-${gantVersion}
  56
  57 Having created local.build.properties with the installDirectory property
  58 definition, to install Gant for the first time, you need to either:
  59
  60 -- install Gant from a distribution as above and then type "gant install";
  61     or
  62
  63 -- type "ant install" -- assuming you have Ant installed.
  64
  65 To install a new build of Gant where one is installed already, you can simply
  66 type "gant install".
  67
  68 Contact
  69 -------
  70
  71 If you have any problems using Gant, or have any ideas for improvements,
  72 please make use of the Gant users mailing list: user@gant.codehaus.org
  73
  74 Russel Winder <russel.winder@concertant.com>
  75
  76 ;;; Local Variables: ***
  77 ;;; fill-column: 78 ***
  78 ;;; End: ***