This is a tracking issue for matters of documentation in this project.
We have reached a state where some parts are becoming solid enough to document without fear of immediate upheaval.
Most importantly, the outward-facing usage of the program must be documented clearly and with sufficient examples.
One such effort is described in #3 as well.
As a concrete task that warrants most attention right now, is the README.
[x] README
Summary.
Basic usage.
Installation.
References to further information and documentation.
This is a tracking issue for matters of documentation in this project.
We have reached a state where some parts are becoming solid enough to document without fear of immediate upheaval. Most importantly, the outward-facing usage of the program must be documented clearly and with sufficient examples. One such effort is described in #3 as well.
As a concrete task that warrants most attention right now, is the README.