diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..59b47c5 --- /dev/null +++ b/INSTALL @@ -0,0 +1,43 @@ +These are generic installation instructions for scsh packages. + +Prerequisites +============= + +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: + + http://lamp.epfl.ch/~schinz/scsh_packages/ + +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. + + +Installation +============ + +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. + +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. + +For example, to install the current package in +"/usr/local/share/scsh-modules", you should type the following: + + scsh-install-pkg --prefix=/usr/local/share/scsh-modules + +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 82a5254..d3dfae9 100644 --- a/README +++ b/README @@ -2,8 +2,8 @@ This is the Scheme Untergrund Networking Package. The Scheme Untergrund Networking Package (SUnet, for short) is a collection of applications and libraries for Internet hacking in -Scheme. It contains over 9000 lines of high-quality Scheme code which -runs under Scsh, the Scheme shell. SUnet which makes extensive use of +Scheme. It contains over 15000 lines of high-quality Scheme code that +runs under Scsh, the Scheme shell. SUnet makes extensive use of Scsh's facilities for multi-threaded systems programming und Unix. SUnet includes the following components: @@ -19,6 +19,9 @@ SUnet includes the following components: * server extensions for uploading Scheme code * simple structured HTML output library + The server also ships with a sophisticated interface for writing + server-side Web applications called "SUrflets". + * The SUnet ftp server This is a complete anonymous ftp server in Scheme. @@ -48,6 +51,9 @@ SUnet includes the following components: * An ls clone This library displays Unix-style directory listings without running ls. +Download +======== + The SUnet code is available from http://www.scsh.net/sunet/ @@ -56,6 +62,28 @@ To run the code, you need version 0.6.4 or later of Scsh, available from http://www.scsh.net/ +Installation +============ + +As of version 2.1 SUnet conforms to the packaging proposal for scsh +(). In short, this means +that you can install SUnet by unpacking the SUnet 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 SUnet package accepts a special option "--with-suflets yes/no" +that controls the installation of the SUrflets library. You need to +install the SSAX package available from + to use the SUrflets +library. + +Support +======= + Please direct questions, comments, answers about SUnet to the regular scsh mailing list at