=========================================================
pyfax: a Python library for generating teletext tti files
=========================================================

Welcome to the pyfax's documention.

****************
Installing pyfax
****************

pyfax can be installed from `GitHub repo <https://github.com/mscroggs/pyfax>`_ by running::

    git clone https://github.com/mscroggs/pyfax.git
    cd pyfax
    python3 setup.py install

Alternatively, the latest release can be installed from PyPI by running::

    pip3 install pyfax

Documentation index
===================
.. toctree::
   :titlesonly: