Installation

Tatoeba-karini is just a Python script.

If you know your way on the command line, with Python and Pip and virtualenviroments, you can safely jump to Quickstart.

If you need more guidance, keep reading. That's why this Wiki is here.

For a more predicted experience, take a look at latest release.

Quickstart

Download or clone the repository. Inside the new directory:

$ pip install -r requirements.txt
$ python tatoeba-karini.py --help

That's it. You are ready to got. Or else, keep reading.

Requirements

Tatoeba-karini is written in Python 3.6*. And you will need that.

All requirements are listed on the requirements.txt file. You can install them manually or by running the following command:

$ pip install -r requirements.txt

Head up! Check the documentation on using pip on your system before doing that. You might need to pass the --user flag to the command if you don't wanna mess up with your system's Python. Alternatively, consider learning how to create a virtual environment (tip: Python is bundled with venv!).

If all of that doesn't make sense and/or is not enough, please consider creating an issue and report how can this document be improved.

Following HEAD

After completing a milestone, a release tag is created.

After that, new patches to reach the next milestone will merged into the master branch.

Since there are no automated tests yet, everything is manually tested and, obviously error-prone.

To run the code on master just follow the step above on the quickstart.

Just remember to pull to keep it updated:

$ git checkout master
$ git pull