commit 7725dcb8c6e9538721b16ed56435b795d0e168bc Author: vaydheesh Date: Mon Aug 26 14:02:51 2019 +0530 updated: readme.md diff --git a/README.md b/README.md index 153aa9a..e3d52e1 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,25 @@ - This project is an attempt to make the Apertium modules available in python, which because of it's simplicity is more appealing to users. ## About the Exisiting Code Base -- The exisiting code base has the subprocess and swig wrapper implementation of the basic functions of Apertium. +- The exisiting code base has the subprocess and swig wrapper implementation of the basic functions of Apertium. + +## Installation +- Installation on Ubuntu and Windows is natively supported + ```bash + git clone https://github.com/apertium/apertium-python.git + cd apertium-python + python setup.py install + ``` + +- For developers, pipenv can be used to install the dependencies + ``` + pip install pipenv + pipenv install --dev --system + ``` + +- Apertium packages can be installed from python interpreter as well. + - Install `apertium-all-dev` by calling `apertium.installer.install_apertium()` + - Install english language package by calling `apertium.installer.install_module(language_name)`. For example `apertium-eng` can be installed by executing `apertium.installer.install_module('eng')` ## Usage of library @@ -86,4 +104,4 @@ Method 2: Calling `translate()` directly. In [1]: import apertium In [2]: apertium.translate('en', 'spa', 'cats') Out[2]: 'Gatos' -``` \ No newline at end of file +```