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.

Sign up for GitHub

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

Jump to bottom

Finish off comprehensive documentation and tutorial guide #11

Open

neechbear opened this issue Mar 20, 2018 · 0 comments

Milestone

Member

neechbear commented Mar 20, 2018

The current documentation is lacking at best, and borderline useless at worst.

A step by step tutorial needs to be written to explain how the tool works and how to set it up from first principles.

It should include a conceptual/architectural design diagram. A plain old ASCII diagram will do.

Depending on how detailed this is, it might need to be a separate markdown file, with the bare minimum quickstart remaining in the README.md.

This relates closely to issue #6.

neechbear added this to the v1.4 MVP milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment