README

Tamil and English: `apertium-tam-eng`
===============================================================================

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

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

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-tam
* apertium-eng

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:

```console
$ ./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` with `./configure`, make sure to use the same `--prefix` when running
`./configure` here.

Testing
-------------------------------------------------------------------------------

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

```console
$ echo "சோதனை வசனம்" | apertium -d . tam-eng
test sentence

$ echo "The boy threw fast." | apertium -d . eng-tam
பையன் வேகமாக எறிந்தான்.
```

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

```console
$ echo "சோதனை வசனம்" | apertium tam-eng
test sentence
```

Files and data
-------------------------------------------------------------------------------

* [`apertium-tam-eng.tam-eng.dix`](apertium-tam-eng.tam-eng.dix) - Bilingual dictionary
* [`apertium-tam-eng.tam-eng.rtx`](apertium-tam-eng.tam-eng.rtx) - Structural transfer rules for translating into English
* [`apertium-tam-eng.eng-tam.rtx`](apertium-tam-eng.eng-tam.rtx) - Structural transfer rules for translating into Tamil
* [`apertium-tam-eng.tam-eng.lrx`](apertium-tam-eng.tam-eng.lrx) - Lexical selection rules for translating into English
* [`apertium-tam-eng.eng-tam.lrx`](apertium-tam-eng.eng-tam.lrx) - Lexical selection rules for translating into Tamil
* [`modes.xml`](modes.xml) - Translation modes

For more information
-------------------------------------------------------------------------------

* https://wiki.apertium.org/wiki/Installation
* https://wiki.apertium.org/wiki/apertium-tam-eng
* 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 (irc://irc.oftc.net/#apertium)

See also the file [`AUTHORS`](AUTHORS), included in this distribution.