From 83b497e65c2e819bc9a3487ce055b626f44a8276 Mon Sep 17 00:00:00 2001
From: michel-schinz <michel-schinz>
Date: Sun, 13 Jun 2004 17:49:05 +0000
Subject: [PATCH] - adapted to the new pkg-def.scm, - provided an example
 installation command, - specify which section of the doc. must be read.

---
 README | 45 +++++++++++++++++++++++++++++++++------------
 1 file changed, 33 insertions(+), 12 deletions(-)

diff --git a/README b/README
index 59b496d..7d1233b 100644
--- a/README
+++ b/README
@@ -9,8 +9,8 @@ install extension libraries for scsh.
 The complete documentation for this library can be found in
 doc/install-lib.pdf. Apart from describing the library itself, this
 document also explains how to install and use scsh packages in
-general. Reading this document at least once before proceeding further
-is strongly recommended.
+general. At least Sections 3 and 4 of this document should be read
+before proceeding further.
 
 Notice that this library needs scsh v0.6.6 or newer, and will not
 work at all with older versions.
@@ -28,30 +28,51 @@ called "scsh-install-pkg", to install other packages later.
 
 Installation is performed by running the "install.scm" script found in
 the same directory as the present file. This script must at least be
-provided with the following two parameters:
+provided with the following parameter:
 
-  --prefix <dir>   prefix directory for the "install-lib" package
+  --prefix <dir>
 
-  --bindir <dir>   directory in which to install the wrapper script
+    The prefix directory in which the "install-lib" package is to be
+    installed. Please notice that this is *NOT* exactly the same as
+    configure's prefix.
+
+    Ideally, you should choose one prefix now and then stick to it
+    when installing further packages, as this will greatly simplify
+    their use.
+
+Optionally, the directory in which to install the wrapper script
+("scsh-install-pkg") can be specified using the "--bindir" option. By
+default, the directory in which scsh itself is installed will be used.
 
 Other parameters can also be supplied (--help, --layout, --verbose,
 --dest-dir, etc.), as explained in the documentation.
 
-The following files are installed:
+As an example, to install everything in /usr/local one could invoke
+the installation script as follows:
 
-  <bindir>/scsh-install-pkg
+  ./install.scm --bindir /usr/local/bin --prefix /usr/local/share/scsh
+
+This would install the following files (where <v> stands for the
+current version of the installation library, e.g. 1.0.0):
+
+  /usr/local/bin/scsh-install-pkg
 
     The script to run in order to install scsh packages. Its use is
     explained in the documentation.
 
-  <prefix>/<scheme_location>/install-lib.scm
-  <prefix>/<scheme_location>/install-lib-version.scm
-  <prefix>/<scheme_location>/install-lib-module.scm
-  <prefix>/<base_location>/load.scm
+  /usr/local/share/scsh/0.6/install-lib-<v>/scheme/install-lib-module.scm
+  /usr/local/share/scsh/0.6/install-lib-<v>/scheme/install-lib-version.scm
+  /usr/local/share/scsh/0.6/install-lib-<v>/scheme/install-lib.scm
+  /usr/local/share/scsh/0.6/install-lib-<v>/load.scm
 
     The Scheme code for the installation library.
 
-  <prefix>/<doc_location>/pdf/install-lib.pdf
+  /usr/local/share/scsh/0.6/install-lib
+
+    A link pointing to /usr/local/share/scsh/0.6/install-lib-<v>,
+    used to designate the current version of this package.
+
+  /usr/local/share/scsh/0.6/install-lib-<v>/doc/pdf/install-lib.pdf
 
     The documentation describing the installation library, and how to
     manage scsh packages in general.