Suomi-malaga - Voikko edition
=============================

General information
-------------------

Suomi-malaga is a description of Finnish morphology written in Malaga
(http://home.arcor.de/bjoern-beutel/malaga/). You should use malaga
version 7.8 or later.

Currently Suomi-malaga is used in two different applications: text
indexer Sukija and spellchecker/hyphenator Voikko. Version 1.0 and
later will work with both applications.

All of the documentation about Finnish morphology is in Finnish (see
README.fi and subdirectory doc). This README contains only build
and usage instructions for distribution packagers.


Build and installation
----------------------

Building Suomi-malaga for from this package requires malaga, python
and make. No configuration is required: to build the code for Voikko,
you only need to run
    make voikko
Installation can be done by running
    make voikko-install DESTDIR=/usr/lib/voikko
(Replace /usr/lib/voikko with the directory you want to install the
files to. Installing to ~/.voikko will cause libvoikko to use this
version of Suomi-malaga only for the user who does the installation.)
Building the code for Sukija can be done by running
    make sukija

Supported Make targets
----------------------

- sukija
  Builds the binary files needed by text indexer Sukija.
- voikko
  Builds the binary files needed by libvoikko.
- voikko-install DESTDIR=/usr/lib/voikko
  Installs the binary files needed by libvoikko to the directory
  specified by DESTDIR. DESTDIR is optional and defaults to
  /usr/lib/voikko
- voikko-preprocessed-l-gzip
  Builds the partial source package that contains only binaries
  and sources that are needed to create custom vocabulary files
  for little endian architectures.
  Note that this package alone does not satisfy the source
  distribution requirements of the GPL. If you distribute it,
  you must make the full source package available as well.
- dist-gzip
  Builds the full source package.
- clean
  Removes all files generated by other targets.
- update-vocabulary
  Updates the XML vocabulary from the nightly snapshot at
  joukahainen.lokalisointi.org. This target requires wget to
  be available.


Variables for tuning the build process
--------------------------------------

- make voikko, make voikko-preprocessed-l-gzip:
  * MIN_FREQUENCY=n
    Limits the words to be included in the .lex files to the
    specified higher frequency class. Default is 9.

Copyright and license information
---------------------------------

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version. See file COPYING for details.

Copyright (©) 2006 - 2007 Hannu Väisänen (Email: Firstname.Lastname@joensuu.fi
but replace ä's with a's) and 2006 - 2007 Harri Pitkänen (hatapitk@iki.fi).
Contributors listed in file CONTRIBUTORS hold copyrights to the
vocabulary data.