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

Document application usages and examples #12

Open
cardil opened this issue Feb 16, 2018 · 0 comments
Open

Document application usages and examples #12

cardil opened this issue Feb 16, 2018 · 0 comments

Comments

@cardil
Copy link
Collaborator

cardil commented Feb 16, 2018

Acceptance Criteria

  • There should be README.rst documented with example of installation and usage and links to GitHub wiki for more details
  • Wiki on Github should be populated with detailed documentation about installation, usage, input format with possible values
  • Help in command line program should be extended
  • Linux man page should by generated from RST and attached to wheel package in a way to install it to linux man page (on Ubuntu there is program called rst2man in package docutils-common)
@cardil cardil added the todo label Feb 16, 2018
@cardil cardil added this to the Release v1.0 - First stable release milestone Feb 16, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant