Faroese and Danish

                            apertium-fao-dan
===============================================================================

This is an Apertium language pair for translating between Faroese and 
Danish. What you can use this language package for:

* Translating between Faroese and Danish
* Morphological analysis of Faroese and Danish
* Part-of-speech tagging of Faroese and Danish

For information on the latter two points, see subheading "For more 
information" below

Requirements
===============================================================================

You will need the following software installed:

* lttoolbox (>= 3.3.0)
* apertium (>= 3.3.0)
* vislcg3 (>= 0.9.9.10297)
* hfst

If this does not make any sense, we recommend you look at: apertium.org

Compiling
===============================================================================

In addition to this folder (apertium-fao-dan) you will need to fetch and compile
apertium-dan (also from https://github.com/apertium) for analysing Danish
You will also need the Faroese analyser
https://github.com/giellalt/lang-fao. The latter should be installed
(see giellalt.github.io) and then compiled with the configuration
./configure --enable-apertium

Given these requirements being installed, you should be able to just run:

$ ./autogen.sh --with-lang1=/path/to/lang-fao/mt/apertium --with-lang2=/path/to/apertium-dan
$ make
# make install


Testing
===============================================================================

If you are in the source directory after running make, the following
commands should work:

$  echo "TODO test sentence 1" | apertium -d . fao-dan
TODO test translated sentence 1

$ echo "TODO test sentence 2" | apertium -d . dan-fao
TODO test translated sentence 2

After installing somewhere in $PATH, you should be able to do e.g.

$  echo "TODO test sentence 1" | apertium fao-dan
TODO test translated sentence 1

Files and data
===============================================================================

* apertium-fao-dan.fao-dan.dix  - Bilingual dictionary
* apertium-fao-dan.fao-dan.t1x  - Chunking rules for translating into Faroese
* apertium-fao-dan.dan-fao.t1x  - Chunking rules for translating into Danish
* apertium-fao-dan.fao-dan.t2x  - Chunking rules for translating into Faroese
* apertium-fao-dan.dan-fao.t2x  - Chunking rules for translating into Danish
* apertium-fao-dan.fao-dan.t3x  - Chunking rules for translating into Faroese
* apertium-fao-dan.dan-fao.t3x  - Chunking rules for translating into Danish
* apertium-fao-dan.fao-dan.rlx  - Lexical selection rules for translating into Faroese
* apertium-fao-dan.dan-fao.rlx  - Lexical selection rules for translating into Danish
* modes.xml                     - Translation modes

For more information
===============================================================================

* https://wiki.apertium.org/wiki/Installation
* https://wiki.apertium.org/wiki/apertium-fao-dan
* https://wiki.apertium.org/wiki/Using_an_lttoolbox_dictionary

Help and support
===============================================================================

If you need help using this language pair or data, you can contact:

* Mailing list: apertium-stuff@lists.sourceforge.net
* IRC: #apertium on irc.oftc.net

See also the file AUTHORS included in this distribution.