FinFlect version 0.1.3
Copyright (C) 2004, 2005  The FinFlect Team

INTRODUCTION
============

FinFlect is an LGPL-licensed C library that provides tools and algorithms
for inflecting Finnish nouns. Currently FinFlect is in its early stages
of development, but already provides fairly accurate inflection of simple
Finnish nouns.

For the full legal text of the LGPL license, see the file LICENSE.

INSTALLATION INSTRUCTIONS
=========================

Building FinFlect
-----------------

UNIX:

To build the FinFlect core library and the finflect and test executables,
execute the following commands:

	./configure
	make

If the configure script does not exists (e.g. you downloaded a snapshot
or checked the source out straight from version control), you can create
it by issuing the following command:

	make -f Makefile.cvs

If this completes without error, you now have the configure script and
you can do ./configure and make.

If, for some strange reason, even the Makefile.cvs doesn't exist, you can
do the same manually:

	aclocal
	autoheader
	automake
	autoconf

Windows:

See README.txt under the 'windows' directory.

Installing FinFlect
-------------------

UNIX:

After configuring and building FinFlect, you can install it by 

	make install
	
Windows:

See README.txt under the 'windows' directory.

Cleaning the CFinFlect source tree
----------------------------------

After building (and perhaps installing) CFinFlect you might consider
removing the temporary files created during the build process. This is
accomplished by executing

	make clean

ALTERNATIVE BUILD METHOD USING SCONS
====================================

CFinFlect also supports SCons for shorter build times (libtool can be a
nasty overhead) and decreased complexity. Having the SCons build tool
installed, you can build CFinFlect simply with the following command:

	scons

Installing CFinFlect using SCons is equally easy:

	scons install

To clean the source tree, use

	scons -c

Note that instead of building CFinFlect in the directory in which
./configure was executed (as in the automake build method; SCons does
not use ./configure), the SCons build method creates a separate build
directory called 'build' under the root directory of the source tree.
All object, library and executable files are created in this directory.

KNOWN BUGS
==========

- none at the time
  
THE FINFLECT TEAM
=================

- Niklas Laxström <niklas.laxstrom+finflect at gmail.com>
  Head Developer

- Santtu Pajukanta <japsu at iki.fi>
  Developer, Webmaster

- Antti Kaijanmäki <kaijanmaki at mbnet dot fi>
  Developer

You can also find us at #finflect@irc.freenode.org.
Feel free to drop by and say hello.