[Sheepdog] [PATCH] Place INSTALL directions in INSTALL file

[Steven Dake]

It is customary to have a separate INSTALL file which explains how to
build, compile, and install software from source (or upstream pre-built repos).

This patch separates those instructions into separate files.

Signed-off-by: Steven Dake <sdake at redhat.com>
---
 INSTALL |   81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README  |   28 ++++------------------
 2 files changed, 86 insertions(+), 23 deletions(-)
 create mode 100644 INSTALL

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..fde77f6
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,81 @@
+===========================
+Sheepdog Installation Guide
+===========================
+
+Run-time dependencies
+---------------------
+* Three or more x86-64 machines.
+* The corosync and corosync lib package.
+* QEMU 0.13 or later
+
+Compile-time dependencies
+-------------------------
+* GNU Autotools
+* corosync devel package
+* git (when compiling from source repo)
+* svn (when compiling from source repo)
+* nss devel packages (when compiling corosync from source)
+
+Compiling and installing from source
+------------------------------------
+1. Compile or install the Corosync packages:
+
+   Nearly every modern Linux distribution has x86_64 corosync binaries
+   pre-built available via their repositories.  We recommend you use these
+   packages if they are available on your distribution.
+
+   For debian package based systems:
+   $ aptitude install corosync
+
+   For RPM package based systems:
+   $ sudo yum install corosynclib-devel
+
+   If your distribution doesn't provide the corosync packages, or you prefer
+   to compile from source:
+
+   $ svn co http://svn.fedorahosted.org/svn/corosync/branches/flatiron
+   $ cd flatiron
+   $ ./autogen.sh
+   $ ./configure
+   $ sudo make install
+   $ cd ..
+
+2. Download, build and install QEMU with Sheepdog support:
+
+   QEMU 0.13 provides built-in support for sheepdog devies.  Some distributions
+   provide pre-built versions of this newer version of QEMU.  If your
+   distribution has an older version of QEMU or you prefer to compile from
+   source, retrieve the latest QEMU and compile:
+
+   $ git clone git://git.sv.gnu.org/qemu.git
+   $ cd qemu
+   $ ./onfigure
+   $ sudo make install
+   $ cd ..
+
+3. Download, build and install the Sheepdog server and command line tools:
+
+   $ git clone git://sheepdog.git.sf.net/gitroot/sheepdog/sheepdog
+   $ cd sheepdog
+   $ ./autogen.sh
+   $ ./configure
+   $ sudo make install
+   $ cd ..
+
+   Please note, sheepdog supports a "make rpm" target which will generate
+   an rpm package that can be installed on the local machine.  To use this
+   installation method, use the following instructions:
+
+   $ git clone git://sheepdog.git.sf.net/gitroot/sheepdog/sheepdog
+   $ cd sheepdog
+   $ ./autogen.sh
+   $ ./configure
+   $ make rpm
+   $ sudo rpm -ivh x86_64/sheepdog-0.*
+   $ cd ..
+   
+Please read the README file, the sheep(8) or collie(8) man page for further
+usage instructions.
+
+===============================================================================
+Copyright (C) 2009-2010, Nippon Telegraph and Telephone Corporation.
diff --git a/README b/README
index d623548..f3b7ed2 100644
--- a/README
+++ b/README
@@ -22,32 +22,14 @@ Requirements
 
 Install
 -------
-1. Install x86-64 Linux.
-2. Install and setup corosync.
-
-   If you use Debian Squeeze,
-
-   $ aptitude install corosync     # or compile corosync.
-   $ sudo corosync                 # run corosync daemon as root
-
-3. Download QEMU and Sheepdog codes.
-
-   $ git clone git://git.sv.gnu.org/qemu.git
-   $ git clone git://sheepdog.git.sf.net/gitroot/sheepdog/sheepdog
-
-4. Build
-
-   $ cd qemu
-   $ ./configure
-   $ make install
-   $ cd ../sheepdog
-   $ ./autogen.sh
-   $ ./configure
-   $ make install
-   $ cd ..
+Please read the INSTALL file distributed with this package for detailed
+instructions on installing or compiling from source.
 
 Usage
 -----
+* Configure corosync.  Reference the corosync(8) and corosync.conf(5) man page
+  for further details.
+
 * Setup Sheepdog
    1. Launch sheepdog on each machines of the cluster.
 
-- 
1.7.2.2