LP#1382038: Add instructions for implied download/unpack step
authorRemington Steed <rjs7@calvin.edu>
Mon, 21 Nov 2016 15:58:33 +0000 (10:58 -0500)
committerGalen Charlton <gmc@esilibrary.com>
Wed, 7 Dec 2016 16:53:35 +0000 (11:53 -0500)
Occasionally, new users have complained that the installation
instructions making too many assumptions about what a user knows. This
commit explicitly instructs users in downloading the source tarball,
unpacking it, and changing the working directory so they will be ready
for the next instructions.

Signed-off-by: Remington Steed <rjs7@calvin.edu>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>

README

diff --git a/README b/README
index a5b3324..eecf880 100644 (file)
--- a/README
+++ b/README
@@ -20,6 +20,30 @@ follows:
        of installing OpenSRF. You can switch to this account from the *root*
        account by issuing the `su - opensrf` command.
 
+Download and unpack the code
+----------------------------
+
+Issue the following commands as the *user* Linux account.
+
+1. Acquire a stable release tarball from https://evergreen-ils.org/opensrf-downloads/
++
+[source, bash]
+------------------------------------------------------------------------------
+wget http://evergreen-ils.org/downloads/opensrf-2.4.1.tar.gz
+------------------------------------------------------------------------------
++
+[NOTE]
+Developers can find the full source code at the OpenSRF Git repository:
+http://git.evergreen-ils.org/?p=OpenSRF.git
++
+2. Unpack the tarball, and move into that directory:
++
+[source, bash]
+------------------------------------------------------------------------------
+tar -xvf opensrf-2.4.1.tar.gz
+cd opensrf-2.4.1/
+------------------------------------------------------------------------------
+
 Installing prerequisites
 ------------------------