Github | Project Documentation Compendium |Readme Templates

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.

Minimal.md — Quickly set up a very basic, minimal README for your project.

Standard.md — A detailed, comprehensive template that covers all the major aspects of a README.

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!

Bot.md — If you have an awesome Bot that you want to share with others.

IoT.md — This repo nails down the nitty-gritties that go into documenting an IoT project.