Skip to content

Add documentation #5

Open
Open
@agriyakhetarpal

Description

@agriyakhetarpal

Some documentation for the project

  1. Get started
  • Usage instructions
  • Multiple installations
  1. Background
  • History and why I created this, and use cases
  • Limitations (there are a lot!)
  • Comparisons with other package managers
  • How this pip-installable distribution can help

See #11 for the above.

  1. Sphinx (closed as not planned since I do not need versioning for this project and won't benefit from the additional maintenance required from hosted Markdown documentation)
  • Hosted documentation
  • Add extensions
  • Versioning if necessary

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions tot the documentation for users and developers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions