README

English and Santali: `apertium-eng-sat`
===============================================================================

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

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

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

Requirements
-------------------------------------------------------------------------------

You will need the following software installed:

* autoconf
* automake
* pkg-config
* lttoolbox (>= 3.5.1)
* apertium (>= 3.6.1)
* vislcg3 (>= 1.3.1)
* apertium-eng
* apertium-sat

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
$ autoreconf -fvi
$ ./configure
$ make
# make install
```

You can use `./autogen.sh` instead of `autoreconf` and `./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.

If any of this doesn't make sense or doesn't work, see https://wiki.apertium.org/wiki/Install_language_data_by_compiling

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

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

```console
$ echo "TODO test sentence 1" | apertium -d . eng-sat
TODO test translated sentence 1

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

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

```console
$ echo "TODO test sentence 1" | apertium eng-sat
TODO test translated sentence 1
```

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

* [`apertium-eng-sat.eng-sat.dix`](apertium-eng-sat.eng-sat.dix) - Bilingual dictionary
* [`apertium-eng-sat.eng-sat.t1x`](apertium-eng-sat.eng-sat.t1x) - Chunking rules for translating into Santali
* [`apertium-eng-sat.sat-eng.t1x`](apertium-eng-sat.sat-eng.t1x) - Chunking rules for translating into English
* [`apertium-eng-sat.eng-sat.t2x`](apertium-eng-sat.eng-sat.t2x) - Interchunk rules for translating into Santali
* [`apertium-eng-sat.sat-eng.t2x`](apertium-eng-sat.sat-eng.t2x) - Interchunk rules for translating into English
* [`apertium-eng-sat.eng-sat.t3x`](apertium-eng-sat.eng-sat.t3x) - Postchunk rules for translating into Santali
* [`apertium-eng-sat.sat-eng.t3x`](apertium-eng-sat.sat-eng.t3x) - Postchunk rules for translating into English
* [`apertium-eng-sat.eng-sat.lrx`](apertium-eng-sat.eng-sat.lrx) - Lexical selection rules for translating into Santali
* [`apertium-eng-sat.sat-eng.lrx`](apertium-eng-sat.sat-eng.lrx) - Lexical selection rules for translating into English
* [`modes.xml`](modes.xml) - Translation modes

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

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