-*- text -*-

This file describes how to install Oswald on Unix and Dos systems (see
below for how to install Oswald on a DOS system).  If you have
problems installing Oswald, check the PROBLEMS file (in this
directory) for a possible solution.  If that doesn't help, report the
problem as a bug to owner-oswald@lists.lancs.ac.uk.  Check the file
BUGS first to make sure we're not already aware of the problem.


INSTALLING OSWALD ON A UNIX SYSTEM
----------------------------------

REQUIREMENTS:

You will need the following to install Oswald on a Unix system:

* Splus version 3.0 or greater
* An ANSI C compiler (gcc works well)
* [optional] an F77 fortran compiler
  (if you do not have a fortran compiler, delete all .f files from
  Routines/dropout to use .c alternatives)


INSTALLATION:

1.  Create a directory called "oswald" (ideally, as a subdirectory of
     the S "library" directory) where you would like to store the
     Oswald functions, and copy oswald.tar there.

2.  cd to the newly-created oswald directory, and extract the files
    from the tarfile with the command

	tar xvf oswald.tar

3.  Edit the top-level Makefile if necessary (although this should not
    be necessary on most systems).  If not using GNU make, you make
    also need to edit Routines/Makefile.

4.  run `make' in the top-level "oswald" directory; this will
    recursively run `make' in all necessary sub-directories.

5.  To use oswald, run Splus and type "library(oswald)".  If Oswald
    has not been installed in the S-plus library directory, you will
    need to type "library(oswald, lib.loc=<<path>>)" where <<path>> is
    the full pathname to the directory containing the "oswald"
    sub-directory.


INSTALLING OSWALD ON A DOS SYSTEM
---------------------------------

REQUIREMENTS:

You will need the following to install Oswald on a DOS system:

* Splus for Windows, version 4.5
* An unzip program, such as PKUNZIP, or UNZIP-DJ.EXE which is
  available from the Oswald FTP site.

INSTALLATION:

1. Create a directory OSWALD as a subdirectory of the Splus library
   directory (probably C:\Program Files\splus45\library)

	CD C:\Program Files\splus45\library
        MKDIR oswald

2. CD to that directory.

        CD oswald

3. Copy OSWALD.ZIP to the OSWALD directory, and unpack it

	COPY A:\OSWALD.ZIP .
	UNZIP OSWALD.ZIP

   Make sure your UNZIP program preserves directory structure while
   unzipping.  For example PKUNZIP should be run like this:

	PKUNZIP -D OSWALD.ZIP   

   You may now delete OSWALD.ZIP to save on disk space:
	
	DEL OSWALD.ZIP

4. Oswald is now ready for use (all the objects are supplied
   pre-compiled in the _DATA directory), so you may now proceed to 6.
   These S objects were created under version 3.3 of Splus for Windows
   and may not work for earlier versions of Splus for Windows, in
   which case go to section 5 to install from source.

5. (Installing from source.)  Start S-plus from the Windows icon, and
   then enter the following:

	attach("/spluswin/library/oswald/_data",1)
	source("/spluswin/library/oswald/dosinstl.q")
	q()

   [NOTE: If you unzipped OSWALD.ZIP in a directory different from
   C:\SPLUSWIN\LIBRARY\OSWALD, you will need to modify the paths above
   accordingly *and* change the fourth line of the file DOSINSTL.Q to
   the directory where you unzipped OSWALD.ZIP.]

6. Start S-plus as usual, and attach the Oswald libary with:

	library(oswald)

NB: Oswald was compiled using S-plus Version 4.5 Release 1.  Other
versions of S-plus may or may not work with Oswald.  You will get 6
warnings after the command library(oswald) under S-plus 4.5 -- you may
safely ignore these warnings.