From ecc756881ac96d5bcf65be31ba5225517a4f276f Mon Sep 17 00:00:00 2001 From: mainzelm Date: Mon, 19 Apr 2004 09:34:04 +0000 Subject: [PATCH] Updates for the packaging proposal. --- INSTALL | 68 +++++++++++++++++++++++++++------------------------------ README | 42 ++++++++++++++++++++++++++++++----- 2 files changed, 68 insertions(+), 42 deletions(-) diff --git a/INSTALL b/INSTALL index dd7edf8..59b47c5 100644 --- a/INSTALL +++ b/INSTALL @@ -1,47 +1,43 @@ - Installing scx +These are generic installation instructions for scsh packages. - -1. Get Sunterlib 0.4 from +Prerequisites +============= - http://savannah.nongnu.org/download/sunterlib/release.pkg/0.4/sunterlib-0.4.tar.gz +The scsh installation library is required to install this package. +This library *must* be present on your system before the current +package can be installed. It can be obtained from the following Web +page: - and install it. + http://lamp.epfl.ch/~schinz/scsh_packages/ -2. Configure scx +The installation library comes with its own documentation which +explains in detail how to install and use scsh packages. It is +recommended that you read it before installing your first scsh +package. What follows is a very brief summary of this documentation, +intended to get you started quickly. - Just `cd' to the directory containing this INSTALL file and type - ./configure +Installation +============ - * Use the --with-scsh-includes switch to specify the path to the - include directory of the scsh installation (default is - /usr/local/include). +Installation of a scsh package is performed by launching the +"scsh-install-pkg" script, which is part of the scsh installation +library. This script must be launched from within the directory which +resulted from the expansion of the current package's archive, i.e. the +one containing the file you are reading now. - * Use the --with-scsh-libraries switch to specify the path to the - library directory of the scsh installation (default is - /usr/local/lib/scsh) +A list of all the arguments accepted by the "scsh-install-pkg" script +can be obtained by launching it with the "--help" option. One of these +arguments, "--prefix", is mandatory and specifies the location where +installation should be performed. Ideally, you should use the same +prefix to install all scsh packages, as this makes them easier to +manage and use. - * Use the --with-scsh-modules switch to specify the path to the - directory where Sunterlib is installed if this directory is not in - the scsh library path (default is - /usr/local/lib/scsh/modules). See the description of the -ll - option in the scsh manual for more information about the library - path. +For example, to install the current package in +"/usr/local/share/scsh-modules", you should type the following: -3. Build scx by typing + scsh-install-pkg --prefix=/usr/local/share/scsh-modules - make - - This will compile the scx binary and the scx image scx.image. The scx - binary behaves like an ordinary scsh binary but includes bindings for - Xlib and starts the scx.image from the installation directory as - default image. - - You may need to specify additional libraries for linking. This can - either be done by extending the LIBS variable in the Makefile or by - setting the LDFLAGS environment variable as in - - env "LDFLAGS=-lsocket -lnsl" make - -4. There is currently no "install" target, it is recommended to leave - scx and scx.image in the build directory. +Provided that no errors are encountered during installation, a +message will be printed at the end explaining how to use the newly +installed package. diff --git a/README b/README index 4f6af76..4fe43a0 100644 --- a/README +++ b/README @@ -1,18 +1,48 @@ +Scx 0.2 README -*- outline -*- + + Scx library + =========== Scx is an interface to Xlib for the Scheme implementation scsh. Scx is based on the Xlib interface of Elk 3.0 and shares most of the original API. In addition, scx provides bindings to the xft library for font rendering. -Please report bugs to scsh-bugs@zurich.ai.mit.edu. +* Installation +============== -See the file INSTALL for installation instructions. The installation -procedure will produce a new executable "scx" that replaces the "scsh" -executable and an image "scx.image" that the scx executable will -load. Later versions of scx will provide a more convenient way of -building the system. +Starting with version 0.2, scx conforms to the packaging proposal for +scsh by Michel Schinz. Please see: + + + +In short, this means that you can install scx by unpacking the scx +tarball and issuing the following command in the created directory: + +scsh-install-pkg --prefix /path/to/your/package/root + +See the file INSTALL for the generic installation instructions for +scsh packages. + +The scx package accepts a special option "--with-xft " that +controls the installation of the Xft bindings. Enable this option if +your local X installation provides Xft. + +You need to install Sunterlib 0.6 or later from + to use scx. + +* Documentation +=============== There is currently no documentation specific to scx but the description of the original Elk API at http://www-rn.informatik.uni-bremen.de/software/elk/doc.html might be helpful. + +* Support +========= + +Please direct questions, comments, answers about scx to the regular +scsh mailing list at + +scsh@zurich.ai.mit.edu.