commit 772234445c541a7a04206b550997883590fdc2dc Author: elmurod1202 Date: Wed Jul 22 18:25:43 2020 +0200 Added README, a big Upgrade :D diff --git a/README b/README index e69de29..d7ff506 100644 --- a/README +++ b/README @@ -0,0 +1,88 @@ +Turkish (`apertium-tur`) +=============================================================================== + +This is an Apertium monolingual language package for Turkish. What +you can use this language package for: + +* Morphological analysis of Turkish +* Morphological generation of Turkish +* Part-of-speech tagging of Turkish + +Requirements +=============================================================================== + +You will need the following software installed: + +* lttoolbox (>= 3.3.0) +* apertium (>= 3.3.0) +* vislcg3 (>= 0.9.9.10297) + +If this does not make any sense, we recommend you look at: www.apertium.org + +Compiling +=============================================================================== + +Given the requirements being installed, you should be able to just run: + +``` +$ ./configure +$ make +``` + +You can use `./autogen.sh` instead of `./configure` if you're compiling +from GitHub. + +If you're doing development, you don't have to install the data, you +can use it directly from this directory. + +If you are installing this language package as a prerequisite for an +Apertium translation pair, then do (typically as root / with sudo): + +``` +# make install +``` + +You can give a `--prefix` to `./configure` to install as a non-root user, +but make sure to use the same prefix when installing the translation +pair and any other language packages. + + +Testing +=============================================================================== + +If you are in the source directory after running make, the following +commands should work: + +$ echo "TODO: test sentence in Turkish" | apertium -d . tur-morph +TODO: test analysis result + +$ echo "TODO: test sentence in Turkish" | apertium -d . tur-tagger +TODO: test tagger result + + +Files and data +=============================================================================== + +* `apertium-tur.tur.dix` - Monolingual dictionary +* `tur.prob` - Tagger model +* `apertium-tur.tur.rlx` - Constraint Grammar disambiguation rules +* `apertium-tur.post-tur.dix` - Post-generator +* `modes.xml` - Translation modes + +For more information +=============================================================================== + +* http://wiki.apertium.org/wiki/Installation +* http://wiki.apertium.org/wiki/apertium-tur +* http://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.freenode.net` + +See also the file AUTHORS included in this distribution. +