python-tuf/docs/index.rst
Lukas Puehringer 4d1fad233a doc: rename contribution instructions
Rename CONTRIBUTORS.rst -> CONTRIBUTING.rst. The new name is what
GitHub expects and will make the document more discoverable, e.g.
on https://github.com/theupdateframework/python-tuf/contribute.

More details under:
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

Note: I searched all repositories in theupdateframework GitHub
organization for references (there were none) and will update the
links in the CII Best Practice badge app for tuf.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2022-02-09 15:08:45 +01:00

20 lines
695 B
ReStructuredText

TUF Developer Documentation
===========================
This documentation provides essential information for those developing software
with the `Python reference implementation of The Update Framework (TUF)
<https://github.com/theupdateframework/python-tuf>`_.
The reference implementation provides easy-to-use components for Python
developers but also aims to be a readable guide and demonstration for those
working on implementing TUF in their own languages, environments, or update
systems.
.. toctree::
:maxdepth: 1
:caption: Contents:
api/api-reference
INSTALLATION
Usage examples <https://github.com/theupdateframework/python-tuf/tree/develop/examples>
CONTRIBUTING