INSTALL
*******

  This is version 1.0.8 of Tryst.

----------------------------------------------------------------------------


Installing Tryst
================

  Requirements
  ------------

  * GNUstep Core
    - gnustep-make
    - gnustep-base

    To successfully compile and install Tryst, you will need to have the
    latest GNUstep Base installed on your system.

    GNUstep has additional dependencies. Read the appropriate installation
    documentation ( GNUstep-HOWTO ) for further details or visit

       < http://www.gnustep.org/ >
    or < http://wiki.gnustep.org/ >
    or < http://www.gnustep.net/ >
    or < http://www.gnustep.de/ >
    or < http://www.gnustep.it/ >

  * mDNSResponder

    You will also need to have the mDNSResponder project, a component of
    Bonjour, Apple's ease-of-use IP networking initiative:

    http://developer.apple.com/networking/bonjour/index.html
    http://darwinsource.opendarwin.org/tarballs/apsl/
    http://bonjour.macosforge.org/

  * Avahi

    Alternatively, you should be able to use Avahi with mDNSResponder
    compatibility. This is untested, though.

    http://www.avahi.org/

    Note:
    Avahi's development team recommends not using any of Avahi's
    compatibility modules.
    There is a bug in Avahi's mDNSResponder module that sends b0rked service
    announcements back to the receiver. Therefor I'm currently working on
    implementing 'native' Avahi support.



  Updating Tryst
  --------------

  If you are updating Tryst from a previous version, make sure there is only
  one version installed on your system.

  Ideally, that previous version is installed in $GNUSTEP_LOCAL_ROOT or the
  same location you intend to install the current version to.

  Otherwise, GNUstep may not be able to find the correct header files.



  Compiling Tryst
  ---------------

  The following assumes that you already changed to the top Tryst source
  directory ( eg. $HOME/devel/Tryst-<version>/ )

  Typically, there is no need for configuration. On your shell type:

    $ make
    $ make install
    $ make distclean

  ( The $ denotes your SHELL prompt. )
  This will go through each sub-directory successibly, to create all files,
  install them to their proper location and finally clean up.

    Note:
    -----
    You need GNU make ( called 'gmake' or 'gnumake' on some systems. )



  Compiling a DEBUG version of Tryst
  ----------------------------------

  To have a verbose version of Tryst, on your shell type:

    $ make verbose=yes

  ( The $ denotes your SHELL prompt. )
  
  Now if you want to see Tryst dump information, run your application with

    --GNU-Debug=NSNetServices

  and / or

    --GNU-Debug=Trace

  as additional option(s).



  Problems
  --------

  Tryst is ( currently ) only tested on FreeBSD and Solaris. Basically every
  system supported by mDNSResponder should also work -- it's just not tested.

  Sending a patch of your changes to < cbv@gmx.net > will be greatly
  appreciated.



Documentation
=============

  Documentation is automatically derived from source code directly, using
  'autogsdoc'. To create and install the documentation, run

    $ make doc=yes
    $ make doc=yes install
    $ make doc=yes distclean

  ( The $ denotes your SHELL prompt. )
  This will create the documentation as HTML for the framework, install it
  to the proper place and finally clean up.

    Note:
    -----
    You need GNU make ( called 'gmake' or 'gnumake' on some systems. )


----------------------------------------------------------------------------
@end