Skip to content

Finish off comprehensive documentation and tutorial guide #11

@neechbear

Description

@neechbear

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions