Overview
========

The English language has two indefinite articles:

+ *a*: used before words that begin with a consonant sound (e.g., *a program*, *a host*, *a user*);
+ *an*: used before words that begin with a vowel sound (e.g., *an example*, *an hour*, *an undefined variable*).

**anorack** is a specialized spell-checker
that finds incorrect indefinite articles:

.. code:: console

   $ cat test
   a Ubuntu user
   a 8-byte word
   an username

   $ anorack test
   test:1: a Ubuntu -> an Ubuntu /u:b'u:ntu:/
   test:2: a 8 -> an 8 /'eIt/
   test:3: an username -> a username /j'u:z3n,eIm/

Prerequisites
=============

* Python ≥ 3.6

* `eSpeak NG`_ or eSpeak_ ≥ 1.47.08

.. _eSpeak NG:
   https://github.com/espeak-ng/espeak-ng

.. _eSpeak:
   http://espeak.sourceforge.net/

Installation
============

You can use anorack without installing it,
straight out of unpacked source tarball or a VCS checkout.

It's also possible to install it system-wide with::

   # make install

By default, ``make install`` installs the package to ``/usr/local``.
You can specify a different installation prefix
by setting the ``PREFIX`` variable, e.g.::

   $ make install PREFIX="$HOME/.local"

.. vim:ft=rst ts=3 sts=3 sw=3 et
