info/the-documentation-compendium
1
0
Fork 0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-02 17:42:57 +02:00
Code Issues Releases Wiki Activity
Files
master
the-documentation-compendium/en/README_TEMPLATES/README.md
Kyle Lobo 063743ade2 Changed order of templates
2020-05-14 21:54:27 +05:30

696 B
Raw Permalink Blame History

This folder contains various README Templates that one can use based on the type of project.

  1. Minimal.md - Quickly set up a very basic, minimal README for your project.
  2. Standard.md - A detailed, comprehensive template that covers all the major aspects of a README.
  3. Hackathon.md - At a Hackathon and quickly need to set up a beautiful, thorough README that leaves a lasting impression on the judges? This is the template for you!
  4. Bot.md - If you have an awesome Bot that you want to share with others.
  5. IoT.md - This repo nails down the nitty-gritties that go into documenting an IoT project.