New installation instructions and release notes.

Signed-off-by: Chris Cormack <crc@liblime.com>

diff --git a/Makefile.PL b/Makefile.PL
index edd7781..077f36c 100644 (file)
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -29,19 +29,28 @@ Makefile.PL - Koha packager and installer
 
 =head1 SYNOPSIS
 
+=head2 BASIC INSTALLATION
+
        perl Makefile.PL
        make
        sudo make install
+
+=head2 PACKAGING RELEASE TARBALLS
+
        make manifest tardist
        make manifest zipdist
 
+=head2 CLEANING UP
+
+       make clean
+
 =head1 DESCRIPTION
 
 This is a packager and installer that uses
 ExtUtils::MakeMaker, which is fairly common
 on perl systems.
 As well as building tar or zip files
-and installing,
+and installing with the above commands,
 it allows us to check pre-requisites
 and generate configuration files.
 
@@ -65,14 +74,15 @@ Hash of file mappings
 
 =head2 CONFIGURE
 
-Maybe use prompt() here in future to get configuration values at installation time.
+Maybe use prompt() here in future to get configuration values 
+interactively at installation time.
 
 =head2 PL_FILES
 
 This is a hash of PL scripts to run after installation and
 the files to ask them to generate.
 Maybe use the values from CONFIGURE
-to generate initial configuration files.
+to generate initial configuration files in future.
 
 =cut
 
@@ -178,7 +188,7 @@ WriteMakefile(
 =head2 map_tree
 
 This function lists all files and where to install each one.
-It returns a hash reference suitable for PM.
+It returns a hash reference suitable for the PM variable above.
 
 =cut
 

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..31225a2
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,56 @@
+Koha - award-winning GPL Integrated Library System.
+
+Koha is a full-featured . Developed initially in New Zealand by Katipo
+Communications Ltd and first deployed in January of 2000 for Horowhenua
+Library Trust, it is currently maintained by a team of software providers
+and library technology staff from around the globe.
+
+
+STRUCTURE
+=========
+
+Koha 3.0 has been restructured from Koha 2.2 to use Zebra,
+a high-performance, general-purpose structured text indexing and
+retrieval engine.  Zebra speaks Z39.50, building on one of Koha's most
+useful features.
+
+General library data is held in MySQL, and Koha 3.0 supports MySQL 5,
+using foreign keys and other recent features.
+
+Apache 2 is the recommended web server and VirtualHost configuration
+files are generated for it.
+
+
+INSTALLATION
+============
+
+Koha 3.0 comes with a new installer, based on MakeMaker, the tool that
+is usually used to install CPAN modules.  This means that if you know
+how to customise CPAN-installed modules, the same things should work
+for you with Koha.
+
+You need to have a server running MySQL 5, Zebra and some webserver
+(preferably Apache) before installing Koha.  Create a database in
+MySQL called koha and 
+
+Default installation instructions:
+
+1. perl Makefile.PL
+2. make
+3. sudo make install
+4. ln -s /usr/lib/perl5/site-perl/*/koha/etc/koha-httpd.conf /etc/apache2/sites-available/koha
+5. a2ensite koha && /etc/init.d/apache reload
+6. zebrasrv -c /usr/lib/perl5/site-perl/*/koha/etc/koha-conf.xml
+7. Browse to http://servername:8080/ and answer the questions
+
+OR if you want to install all dependencies from CPAN and are root, you can
+replace steps 1-3 with "perl install-CPAN.pl" but this is non-standard and
+may not be safe.  Nevertheless, it's pretty cool when it works.
+
+For instructions on how to override the default settings, run
+perldoc rewrite-config.PL
+
+
+DEVELOPER NOTES
+
+For instructions on how to package releases, run perldoc Makefile.PL

diff --git a/rewrite-config.PL b/rewrite-config.PL
index d17387e..a408210 100644 (file)
--- a/rewrite-config.PL
+++ b/rewrite-config.PL
@@ -31,19 +31,29 @@ rewrite-config.PL - helper for the Koha packager and installer
 
 =head1 DESCRIPTION
 
-This helper script replaces placeholders in the
+This helper script replaces keywords in the
 configuration files with value either supplied through
 the environment (with export, or by putting them on
-the start of the make command linke) or with reasonable
+the start of the make command line) or with reasonable
 guesses worked out by the script.
 
-=head2 KEYS
+=head2 KEYWORDS
 
-The following configuration keys are available:
+The following configuration keywords are available:
 
 BASE_DIR, MYSQL_DB, MYSQL_HOST, MYSQL_PASS, MYSQL_USER, WEBMASTER_EMAIL, WEBSERVER_DOMAIN,
 WEBSERVER_HOST, WEBSERVER_IP, WEBSERVER_PORT, WEBSERVER_PORT_LIBRARIAN, ZEBRA_PASS, ZEBRA_USER
 
+=head1 EXAMPLES
+
+To override the guessed hostname and email address, run:
+
+       WEBSERVER_HOST=mysecrethostname.com.invalid \
+       WEBMASTER_EMAIL=webmaster@publichost.com make install
+
+Note that if WEBSERVER_HOST does not resolve to an IP address, you will
+also need to override WEBSERVER_IP.
+
 =cut
 
 $myhost = hostname();