Preleminaries
=============

Please regard the software requirements at first.
Depending on the kind of file you have downloaded the installation procedure
varies:
- if you have downloaded a source tarball you may choose
  "Installation under GNUstep" or
  "Installation under Mac OS X"
- if you have downloaded a binary version you may choose
  "Installing the binary version (DMG file) on Mac OS X"
  
Note: The binary distribution does not contain the testcases.


Software Requirements
=====================

To install Encore, you need:  
  - Under GNUstep:
    * An Objective-C environment (gcc + rudimentary libraries)
      suitable to be used with GNUstep.
    * GNUstep make (version 1.11) and 
    * GNUstep base (version 1.11)

  - Under Mac OS X:
    * XCode 2.2 or later

It should also be possible to use the specified GNUstep packages and 
a suitable gcc compiler on Mac OS X, but this has not been tested
so much.


Installation under GNUstep
==========================

To compile encore you may follow these steps:
- Switch to Encore root directory
- Run "make install"

To run the tests you may follow these steps:
- Switch to Encore/tests directory
- Run "make"
- Call tests via "shared_obj/EncoreTESTS"
  Note: For correctly running tests you must initiate this
        program within the directory "Encore/tests"


Installation under Mac OS X
===========================

To compile encore and the tests you may follow these steps:
- Switch to Encore root directory
- Open Encore.xcodeproj with XCode
- Choose "Encore" as active target
- Choose configuration "Development" or "Deployment" depending on your
  target environment
- Build project
- Now install the created framework "Encore.framework" into your
  favorite framework installation path.

If you wish to create (and run) the tests:
- Choose "EncoreTESTS" as active target
- Build project
- Run active target


Installation under Mac OS X using the binary distribution (DMG file)
====================================================================

NOT supported at present!


Testing on GNUstep / Mac OS X
=============================

The tests do print their status via NSLog on the console, so that you can directly
see their results.