[commit: Cabal] master: Clarify the instructions in the README and bootstrap.sh (6f036e5)

[Ian Lynagh]

Repository : ssh://darcs.haskell.org//srv/darcs/packages/Cabal

On branch  : master

http://hackage.haskell.org/trac/ghc/changeset/6f036e5dc146ed3e1cfaeddffbbaccccfacd9056

>---------------------------------------------------------------

commit 6f036e5dc146ed3e1cfaeddffbbaccccfacd9056
Author: Duncan Coutts <duncan at haskell.org>
Date:   Sun Mar 15 12:54:07 2009 +0000

    Clarify the instructions in the README and bootstrap.sh
    Addresses the complaint in ticket #523.

>---------------------------------------------------------------

 cabal-install/README       |   34 +++++++++++++++++++++++++++-------
 cabal-install/bootstrap.sh |   12 ++++++++----
 2 files changed, 35 insertions(+), 11 deletions(-)

diff --git a/cabal-install/README b/cabal-install/README
index 05d7efe..b5d8203 100644
--- a/cabal-install/README
+++ b/cabal-install/README
@@ -26,7 +26,8 @@ It requires three other Haskell packages that are not always installed:
 All of these are available from [Hackage](http://hackage.haskell.org).
 
 Note that on some Unix systems you may need to install an additional zlib
-development package using your system package manager. This is because the
+development package using your system package manager, for example on
+debian or ubuntu it is in "zlib1g-dev". It is needed is because the
 Haskell zlib package uses the system zlib C library and header files.
 
 In future, cabal-install will be part of the Haskell Platform so will not need
@@ -38,8 +39,8 @@ standard way, but to make it a bit easier we have partly automated the process:
 Quickstart on Unix systems
 --------------------------
 
-As a convenience for users on Unix systems there is a bootstrap.sh script which
-will download and install each of the dependencies in turn.
+As a convenience for users on Unix systems there is a `bootstrap.sh` script
+which will download and install each of the dependencies in turn.
 
     $ ./bootstrap.sh
 
@@ -50,19 +51,38 @@ be installed into `$HOME/.cabal/bin/`.
 You then have two choices:
 
  * put `$HOME/.cabal/bin` on your `$PATH`
- * move the `cabal` program elsewhere and edit the `$HOME/.cabal/config` file
-   and set the `symlink-bindir` entry to point to an alternative location where
-   that is on your `$PATH`, eg a `$HOME/bin` directory.
+ * move the `cabal` program somewhere that is on your `$PATH`
+
+The next thing to do is to get the latest list of packages with:
+
+    $ cabal update
+
+This will also create a default config file (if it does not already echo exist)
+at `$HOME/.cabal/config`
+
+By default cabal will install programs to `$HOME/.cabal/bin`. If you do not
+want to add this directory to your `$PATH` then you can change the setting in
+the config file, for example you could use:
+
+    symlink-bindir: $HOME/bin
 
 
 Quickstart on Windows systems
 -----------------------------
 
 For Windows users we provide a pre-compiled [cabal.exe] program. Just download
-it and put it somewhere on your `%PATH%`.
+it and put it somewhere on your `%PATH%`, for example
+`C:\Program Files\Haskell\bin`.
 
 [cabal.exe]: http://haskell.org/cabal/release/cabal-install-latest/cabal.exe
 
+The next thing to do is to get the latest list of packages with
+
+    cabal update
+
+This will also create a default config file (if it does not already echo exist)
+at `C:\Documents and Settings\username\Application Data\cabal\config`
+
 
 Using cabal-install
 ===================
diff --git a/cabal-install/bootstrap.sh b/cabal-install/bootstrap.sh
index 79729af..6896421 100644
--- a/cabal-install/bootstrap.sh
+++ b/cabal-install/bootstrap.sh
@@ -132,7 +132,7 @@ install_pkg () {
     || die "Compiling the Setup script failed"
   [ -x Setup ] || die "The Setup script does not exist or cannot be run"
 
-  ./Setup configure --user "--prefix=${HOME}/.cabal" \
+  ./Setup configure --user "--prefix=${PREFIX}" \
     --with-compiler=${GHC} --with-hc-pkg=${GHC_PKG} \
     ${EXTRA_CONFIGURE_OPTS} ${VERBOSE} \
     || die "Configuring the ${PKG} package failed"
@@ -185,10 +185,14 @@ then
     echo "You should either add $CABAL_BIN to your PATH"
     echo "or copy the cabal program to a directory that is on your PATH."
     echo
+    echo "The first thing to do is to get the latest list of packages with:"
+    echo "  cabal update"
+    echo "This will also create a default config file (if it does not already"
+    echo "exist) at $HOME/.cabal/config"
+    echo
     echo "By default cabal will install programs to $HOME/.cabal/bin"
-    echo "If you do not want to add this directory to your PATH then"
-    echo "you can change the setting in the config file $HOME/.cabal/config"
-    echo "For example you could use:"
+    echo "If you do not want to add this directory to your PATH then you can"
+    echo "change the setting in the config file, for example you could use:"
     echo "symlink-bindir: $HOME/bin"
 else
     echo "Sorry, something went wrong."