Changeset 19839 for greenstone3/trunk/README-SVN.txt

Timestamp:

2009-06-15T14:36:18+12:00 (15 years ago)

Author:

kjdon

Message:

some changes for new setup

File:

• greenstone3/trunk/README-SVN.txt (modified) (3 diffs)

greenstone3/trunk/README-SVN.txt

@@ -4 +4 @@
 This is free software, and you are welcome to redistribute it
 
-These are some extra notes for installing Greenstone from SVN. Please also read the README.txt file for general information as almost all of that applies here too.
+These are some extra notes for installing Greenstone from SVN. Please also 
+read the README.txt file for general information as almost all of that applies 
+here too.
+
+You will need Java and Ant to run Greenstone 3. 
+
+Your Java version should be 1.4 or higher. We recommend Sun Java. You need the 
+SDK (development environment). Set the environment variable JAVA_HOME to be 
+the root of your Java installation.
+
+Ant (Apache's Java based build tool) can be downloaded from 
+http://ant.apache.org/bindownload.cgi. Set the environment variable 
+ANT_HOME to be the root of your Ant installation, and make sure the Ant 
+executables are on your PATH. You may have problems with earlier versions. 
+This has been tested with version 1.6.2
 
 Installing Greenstone from an SVN checkout:
@@ -17 +31 @@
 Build and install:
 
-In the greenstone3 directory, edit the build.properties file (see 'Configuring your installation' in README.txt), and run 'ant prepare install'. The two targets can be run separately if you like.
 
-The 'prepare' target will download additional code (using SVN and http), so you need to be online to run it. The 'install' target can be run offline.
+In the greenstone3 directory, check and/or edit the build.properties file. In
+ particular, set the Tomcat port number. See 'Configuring your installation' in
+ README.txt for more information.
 
-The prepare/install targets will ask you if you accept the properties before starting.
+Note, initial  checkouts from SVN have a build.properties.in file. Running 
+'ant' will result in the build.properties file being generated from the .in 
+file (a straight copy).
+
+Then, run 'ant prepare install'. The two targets can be run separately if you 
+like.
+
+The 'prepare' target will download additional code (using SVN and http), so 
+you need to be online to run it. The 'install' target can be run offline.
+
+The prepare/install targets will ask you if you accept the properties before 
+starting.
 To suppress this prompt, use the -Dproperties.accepted=yes flag. E.g.
-ant -Dproperties.accepted=yes prepare install (from CVS), or
+ant -Dproperties.accepted=yes prepare install
+
 To log the output, run
-ant -Dproperties.accepted=yes -logfile build.log prepare install (from CVS), or
+ant -Dproperties.accepted=yes -logfile build.log prepare install 
+
+On Windows, Visual Studio is used for compiling. The VCVARS32.bat script needs 
+to be run in the command prompt before compiling with "ant install".
+
+In the greenstone3 directory, you can run 'ant' which will give you a help 
+message.
+Running 'ant -projecthelp' gives a list of the targets that you can run - these
+do various things like compile the source code, start up the server etc.
 
 Extra Configuration notes:
@@ -33 +68 @@
 including external packages and the Librarian Interface. These will be 
 installed during the Greenstone 3 installation process. If you do not want 
-collection building capability, please set the disable.collection.building property to true in build.properties. 
+collection building capability, please set the disable.collection.building 
+property to true in build.properties.