README tipp for Debian
======================

Programs can be run with the Python launcher files placed into /usr/bin.

Information can be found in the readme and tutorial files written by upstream
developers. Those files lie in /usr/share/doc/tipp/ .
Yet, the Debian packaging incorporates some changes, mainly concerning
configuration files. These are highlighted in the next lines.


Differences to tipp (upstream)
------------------------------

The upstream packaging of tipp includes a file path.config which contains a
single line with the directory in which the configuration files lie.

We have removed this file and instead placed default versions of the
configuration files in /etc/tipp/ . These can be overridden by every user by
copying them into a .tipp/ directory in their home directory, for instance by
executing
        mkdir ~/.tipp && cp /etc/tipp/*.config ~/.tipp/

We have also renamed the upstream file from main.config to tipp.config .


Tipp: getting the reference dataset and setting things up
---------------------------------------------------------

Tipp uses a reference dataset, which can be found at
        https://obj.umiacs.umd.edu/tipp/tipp2-refpkg.tar.gz

The user willing to use Tipp should thus download the dataset and either have
their system administrator set its path in the [reference] section of tipp.config
(see manpage tipp.config(5)) or create their own configuration files as explained
above to be able to edit ~/.tipp/tipp.config to put the path to the dataset in
the [reference] section.