SCPL: logos and TPac templates

[transitory.git] / README

diff --git a/README b/README
index 5cda9a8..5174b49 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
-README for Evergreen master
-===========================
+Installing the Evergreen server
+===============================
 :toc:
 :numbered:
 
@@ -32,7 +32,7 @@ follows:
        Evergreen that you will use to test connectivity and configure your
        Evergreen instance.
 
-Preamble: Developer instructions
+Preamble: developer instructions
 --------------------------------
 
 [NOTE]
@@ -54,7 +54,7 @@ source directory to generate the configure script and Makefiles:
 
 [source, bash]
 ------------------------------------------------------------------------------
-./autogen.sh
+autoreconf -i
 ------------------------------------------------------------------------------
 
 After running `make install`, developers also need to install the Dojo Toolkit
@@ -76,7 +76,7 @@ Installing prerequisites
 Evergreen has a number of prerequisite packages that must be installed
 before you can successfully configure, compile, and install Evergreen.
 
-1. Begin by installing the most recent version of OpenSRF (2.0 or later).
+1. Begin by installing the most recent version of OpenSRF (2.1 or later).
    You can download OpenSRF releases from http://evergreen-ils.org/opensrf.php
 2. On many distributions, it is necessary to install PostgreSQL 9 from external
    repositories.
@@ -103,13 +103,13 @@ add-apt-repository ppa:pitti/postgresql
 +
   * Ubuntu Precise comes with PostgreSQL 9, so no additional steps are required.
 +
-  * Fedora 16 comes with PostgreSQL 9, so no additional steps are required.
+  * Fedora comes with PostgreSQL 9, so no additional steps are required.
 +
 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
    retrieve the new packages from the backports repository.
 4. Issue the following commands as the *root* Linux account to install
    prerequisites using the `Makefile.install` prerequisite installer,
-   substituting `debian-squeeze`, `fedora16`, `ubuntu-lucid`, or
+   substituting `debian-squeeze`, `fedora`, `ubuntu-lucid`, or
    `ubuntu-precise` for <osname> below:
 +
 [source, bash]
@@ -163,7 +163,7 @@ Installation instructions
 +
 [source, bash]
 ------------------------------------------------------------------------------
-make STAFF_CLIENT_STAMP_ID=rel_name install
+make STAFF_CLIENT_STAMP_ID=rel_2_3_0 install
 ------------------------------------------------------------------------------
 +
 2. The server portion of the staff client expects `http://hostname/xul/server`
@@ -329,7 +329,7 @@ make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_91
 You can install the packages required by Fedora on the machine of your choice
 using the following commands as the *root* Linux account:
 
-.(Fedora 16) Installing PostgreSQL server packages
+.(Fedora) Installing PostgreSQL server packages
 [source, bash]
 ------------------------------------------------------------------------------
 make -f Open-ILS/src/extras/Makefile.install install_fedora_pgsql_server
@@ -351,7 +351,7 @@ cpan MARC::File::XML
 cpan UUID::Tiny
 ------------------------------------------------------------------------------
 
-.(Fedora 16) Installing additional Perl modules on a standalone PostgreSQL 9 server
+.(Fedora) Installing additional Perl modules on a standalone PostgreSQL 9 server
 [source, bash]
 ------------------------------------------------------------------------------
 yum install gcc perl-XML-LibXML perl-XML-LibXSLT perl-Business-ISBN
@@ -397,13 +397,20 @@ Evergreen administrator account to your requested values.
 Creating the database on a remote server
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 In a production instance of Evergreen, your PostgreSQL server should be
-installed on a dedicated server. For PostgreSQL 9.1 and later you should be
-able to continue to use the --create-database flag on eg_db_config.pl, without
-needing to install any server modules on your application machine. For
-PostgreSQL 9.0 you can either:
+installed on a dedicated server.
+
+PostgreSQL 9.1 and later
+^^^^^^^^^^^^^^^^^^^^^^^^
+To create the database instance on a remote database server running PostgreSQL
+9.1 or later, simply use the `--create-database` flag on `eg_db_config.pl`.
+
+For PostgreSQL 9.0
+^^^^^^^^^^^^^^^^^^
+To create the database instance on a remote database server running PostgreSQL
+9.0, you can either:
 
   *  Install the PostgreSQL contrib modules on the machine on which you
-     are installing the Evergreen code, and use the --create-database
+     are installing the Evergreen code, and use the `--create-database`
      option from that machine, or
   *  Copy the `Open-ILS/src/sql/Pg/create_database.sql` script to your
      PostgreSQL server and invoke it as the *postgres* Linux account:
@@ -533,3 +540,10 @@ Getting help
 Need help installing or using Evergreen? Join the mailing lists at
 http://evergreen-ils.org/listserv.php or contact us on the Freenode
 IRC network on the #evergreen channel.
+
+License
+-------
+This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
+Unported License. To view a copy of this license, visit
+http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
+Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.