qcl icon indicating copy to clipboard operation
qcl copied to clipboard

Basic documentation

Open Diazonium opened this issue 8 years ago • 2 comments

Right now there is almost zero documentation. For example it would be useful to document the format of the template files that this program expects. I would have tried using the conformer code but could not figure out how, and the built in help messages are not very useful.

Of course one could say the code is the documentation, but not everyone is fluent in python.

Diazonium avatar Feb 18 '17 14:02 Diazonium

Is the documentation of the README.md sufficient, or were you hoping for something like a read-the-docs?

ben-albrecht avatar Jun 06 '17 20:06 ben-albrecht

For the most part it is enough, the only thing that is still not clear is how the template files are expected to be structured. Having an example template should be good enough.

Diazonium avatar Jun 07 '17 05:06 Diazonium