diff --git a/README b/README index c08d03f..59b496d 100644 --- a/README +++ b/README @@ -7,9 +7,10 @@ This is the scsh installation library, which aims at making it easy to install extension libraries for scsh. The complete documentation for this library can be found in -doc/proposal.pdf. Apart from describing the library itself, this +doc/install-lib.pdf. Apart from describing the library itself, this document also explains how to install and use scsh packages in -general. +general. Reading this document at least once before proceeding further +is strongly recommended. Notice that this library needs scsh v0.6.6 or newer, and will not work at all with older versions. @@ -21,35 +22,36 @@ Installation This library must be installed before any attempt at installing scsh packages is made. -Installation is performed by running the install.scm script found in -the same directory as the present file. This script accepts the -following option: +Since version 1.1, this library installs itself as a scsh package +called "install-lib", and additonally installs a small wrapper script +called "scsh-install-pkg", to install other packages later. - --prefix directory in which to install files - (default: /usr/local) +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: + + --prefix prefix directory for the "install-lib" package + + --bindir directory in which to install the wrapper script + +Other parameters can also be supplied (--help, --layout, --verbose, +--dest-dir, etc.), as explained in the documentation. The following files are installed: - /bin/scsh-install-pkg + /scsh-install-pkg The script to run in order to install scsh packages. Its use is - explained in the documentation (see below). + explained in the documentation. - /share/scsh/install-lib/scheme/install-lib.scm - /share/scsh/install-lib/scheme/install-lib-module.scm + //install-lib.scm + //install-lib-version.scm + //install-lib-module.scm + //load.scm The Scheme code for the installation library. - /share/doc/scsh/install-lib/proposal.pdf + //pdf/install-lib.pdf The documentation describing the installation library, and how to manage scsh packages in general. - - -Staged installation -------------------- - -The installation script provides support for staged installation, as -needed by some package managment systems. The destination directory in -which files should be installed can be specified using the -"--dest-dir" option.