============================
OgreKit (GNUstep) 1.2 README
============================

OgreKit is a regular expression library written in Objective-C in Cocoa. It 
uses OniGuruma as regular expression engine.

This is a GNUstep fork of OgreKit 2.1.2 
<http://www8.ocn.ne.jp/~sonoisa/OgreKit/>.
Since it is a fork, the API may differ in the future.

Original licence of OgreKit is BSD License. 
This fork uses also BSD license (see COPYING document).

Maintainer: Yen-Ju Chen <yjchenx at_ gmail __dot com>
Author: Yen-Ju Chen

To know more about OgreKit: 
<http://www.dromasoftware.com/etoile/mediawiki/index.php?title=OgreKit>


Build and Install
-----------------

Read INSTALL document.


Mac OS X support
----------------

Please use original OgreKit unless portability is considered.
OgreKit (GNUstep) is compatible with Cocoa.


Developer notes
===============

Tests suite
-----------

UnitKit (bundled with Etoile) is required.

    Steps to produce a test bundle and run tests suite:

    * make test=yes 

    * ukrun OgreKit.bundle


Dependency
---------

OniGuruma 4 <http://www.geocities.jp/kosako3/oniguruma/>
(It does not work with OniGuruma 5 yet).


Contribute 
----------

Read TODO document.