
KRoC Linux -- Source Distribution
=================================


Installation
------------

To  install  the  source  distribution,  unpack  the  .tar
archive,  cd   to   the   directory   where   it  unpacked
(cd .../kroc/),  and run  the 'build' script.  The  script
will configure,  compile and setup  the KRoC distribution.
Calling the  script with the --help option will bring up a
list of available options.

In order  to compile  KRoC, you  will need  the relevant C
development  packages for  your  system.  In  Debian,  for
example, these are "libc6-dev" and "linux-kernel-headers".
You will also need the GNU C compiler (gcc).

It is possible to  install  the run-time  software  into a
directory other than where the sources are kept.  This can
be set using the '--install-dir <directory>' option to the
'build' script.  The first time the script is run, it will
prompt  for  this  (with  the  source-tree as  the default
installation directory).  To re-configure the KRoC install
use "./build --reconf".


Configuration
-------------

Before using  KRoC, remember  to source the relevant setup
file  (bin/setup.sh  for  sh/bash,  or  bin/setup.csh  for
csh/tcsh).  It may  be convenient to include this `source'
command  in the start-up  file for shell being used  (e.g.
~/.bash_profile,  ~/.cshrc),  or in the  system-wide shell
startup files (e.g.  /etc/profile  and  /etc/csh.cshrc  or
/etc/.login).


Directories
-----------

  install/

    This is the default installation base for KRoC.

  doc/

    This contains various items of documentation.  Essential reading is
    the `essentially-kroc.txt' file.

  src/

    This holds all the source files for this release and may be deleted if
    you wish.  Please note that everything is under either the GNU GPL or LGPL.

  syncs/

    This holds the sources for the extra synchronisation primitives (BARRIER,
    BUCKET, SEMAPHORE and CREW) supported by this release.  There are also
    some demonstration examples.  Documentation for these is in the `docs/'
    directory.

  course/

    This contains material for the course at the University of Kent.
    This includes the sources for its course library (#USE "course.lib"),
    which are compiled into the KRoC library during the `build' operation
    for this release.

  dynproc/

    This contains the occam interface and example programs for dynamic occam
    processes.

  udc/

    This contains the occam interface and example programs for user-defined
    channels.

  cif/

    This contains the CIF (C interface) libraries and examples.

  sdlraster/

    This contains the SDLRaster (SDL based raster graphics) libraries and
    examples.

  demos/

    Various extra demo programs.

  licenses/

    This contains the GNU GPL and LGPL licenses.


Note: most directories contain further README files.


Copyleft
--------

Information about the GNU public license can be found at:

        http://www.gnu.org/copyleft/

The two licenses this distribution uses are provided (GPL and LGPL).


Problems / Bugs
---------------

Known bugs are given in the top-level BUGS file.  If the package
fails to  build,  mail  'F.R.M.Barnes@kent.ac.uk'  with a  brief
description of the  problem and a copy of the  'typescript' file
generated by 'build'.

Problems with  individual  occam programs should be  sent to the
relevant author (usually mentioned in the source code),  or more
generally to 'ofa-bugs@kent.ac.uk'.

