Skip to content

Improve README #2

Description

@Foxbud

Until a wiki has been set up, the README is the only guide to using this library. Therefore, it should explain the following:

  • how to install the library
  • what each of the renderer mixins (and soon to be added renderer classes) does
  • how to extend BaseRenderer to implement more advanced functionality not covered by the mixins
  • what the various errors provided by the library mean
    • how to interpret error messages
    • making use of the tag_stack_trace property provided by most errors

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions