README

# English and Catalan: apertium-eng-cat

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

* Translating between English and Catalan
* Morphological analysis of English and Catalan
* Part-of-speech tagging of English and Catalan

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)
* apertium-eng
* apertium-cat

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

## Compiling

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

    $ ./configure
    $ make
    # make install

You can use `./autogen.sh` instead of `./configure` in case you're compiling from
source. If you installed any prerequisite language packages using a --prefix
to ./configure, make sure to give the same --prefix to ./configure here.

## Testing

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

    $  echo "TODO test sentence 1" | apertium -d . eng-cat
    TODO test translated sentence 1

    $ echo "TODO test sentence 2" | apertium -d . cat-eng
    TODO test translated sentence 2

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

    $  echo "TODO test sentence 1" | apertium eng-cat
    TODO test translated sentence 1

## Files and data

* apertium-eng-cat.eng-cat.dix  - Bilingual dictionary
* apertium-eng-cat.eng-cat.t1x  - Chunking rules for translating into Catalan
* apertium-eng-cat.cat-eng.t1x  - Chunking rules for translating into English
* apertium-eng-cat.eng-cat.t2x  - Interchunk (stage 1) rules for translating into Catalan
* apertium-eng-cat.cat-eng.t2x  - Interchunk rules for translating into English
* apertium-eng-cat.eng-cat.t3x  - Interchunk (stage 2) rules for translating into Catalan
* apertium-eng-cat.cat-eng.t3x  - Postchunk rules for translating into English
* apertium-eng-cat.eng-cat.t4x  - Postchunk rules for translating into Catalan
* apertium-eng-cat.eng-cat.lrx  - Lexical selection rules for translating into Catalan
* apertium-eng-cat.cat-eng.lrx  - Lexical selection rules for translating into English
* modes.xml                     - Translation modes

## For more information

* https://wiki.apertium.org/wiki/Installation
* https://wiki.apertium.org/wiki/apertium-eng-cat
* 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.