Sorani Kurdish and English

                            apertium-ckb-eng
===============================================================================

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

* Translating between Sorani Kurdish and English
* Morphological analysis of Sorani Kurdish and English
* Part-of-speech tagging of Sorani Kurdish 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-ckb
* 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:

$ ./configure
$ make
# make install

You can use ./autogen.sh instead of ./configure you're compiling from
SVN. 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 . ckb-eng
TODO test translated sentence 1

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

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

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

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

* apertium-ckb-eng.ckb-eng.dix  - Bilingual dictionary
* apertium-ckb-eng.ckb-eng.t1x  - Chunking rules for translating into Sorani Kurdish
* apertium-ckb-eng.eng-ckb.t1x  - Chunking rules for translating into English
* apertium-ckb-eng.ckb-eng.t2x  - Interchunk rules for translating into Sorani Kurdish
* apertium-ckb-eng.eng-ckb.t2x  - Interchunk rules for translating into English
* apertium-ckb-eng.ckb-eng.t3x  - Postchunk rules for translating into Sorani Kurdish
* apertium-ckb-eng.eng-ckb.t3x  - Postchunk rules for translating into English
* apertium-ckb-eng.ckb-eng.lrx  - Lexical selection rules for translating into Sorani Kurdish
* apertium-ckb-eng.eng-ckb.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-ckb-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: [email protected]
* IRC: #apertium on irc.oftc.net

See also the file AUTHORS included in this distribution.