Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Basic documentation #2

Open
Diazonium opened this issue Feb 18, 2017 · 2 comments
Open

Basic documentation #2

Diazonium opened this issue Feb 18, 2017 · 2 comments

Comments

@Diazonium
Copy link

Diazonium commented Feb 18, 2017

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.

@ben-albrecht
Copy link
Owner

ben-albrecht commented Jun 6, 2017

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

@Diazonium
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants