Badging for Checklist Compliance

If you want to proclaim that your project’s documentation satisfies version 1 of the One Good Tutorial checklist, consider adding a badge that looks like this to your README, or wherever else is appropriate:

One Good Tutorial docs checklist v1: adopted

The Markdown code to create this badge is:

[![One Good Tutorial docs checklist v1: adopted](https://onegoodtutorial.org/badge/adopted-v1.svg)](https://onegoodtutorial.org/about/badge/?v=1)

The equivalent in reStructuredText is:

.. image:: https://onegoodtutorial.org/badge/adopted-v1.svg
   :alt: One Good Tutorial docs checklist v1: adopted
   :target: https://onegoodtutorial.org/about/badge/?v=1

And finally, plain HTML:

<a href="https://onegoodtutorial.org/about/badge/?v=1">
  <img src="https://onegoodtutorial.org/badge/adopted-v1.svg"
    alt="One Good Tutorial docs checklist v1: adopted" />
</a>

The code above will result in a clickable badge that takes people to this page, which gives a short explanation of the One Good Tutorial checklist concept.

Another way to advertise your use of the checklist is to mention One Good Tutorial in your acknowledgements. If you found One Good Tutorial useful, you’re encouraged — but not obligated — to do so.