humburg/pirates

Create user guide

Opened this issue · 0 comments

In addition to the documentation for python objects (mostly targeted at developers, see #13) we also need documentation of the user interface. This should include an explanation of command-line parameters as well as some general advice on how to use the tool and interpret its output. We may also want a description of the algorithm.

This user-facing documentation could either be hosted on Read the Docs alongside the more technical documentation or on GitHub Pages.