README Template

README format.txt

PROJECT NAME	[The name of the project or repository]
============	[ “=” symbols, one per character in the project name]
[1 empty line after divider]

One-line summary of the project.



# About		[h1 heading; space separating # and heading title; 1 # per heading level]
[3 empty lines preceding h1s, 2 empty lines before h2-h6; at least 1 empty line after headings]

Long-form about section for the project



# Setup


## Prerequisites

* List of everything needed
* Linkify items, if possible


## Installation

* Any installation notes regarding the project (not the prerequisite installation)



# Editing

How to edit the project.


## Components

A breakdown of how the project works.



# Build Process

Instructions/scripts on the build/compilation process. Include separate instructions for Continuous Integration if it differs.



# Testing


## Unit Tests

Instructions to execute tests and view reports. Include separate instructions for Continuous Integration if it differs.


## Integration Tests

Instructions to execute tests and view reports. Include separate instructions for Continuous Integration if it differs.



# Deploying

Instructions on deploying to the project to any/all applicable environments.



# Notes


## Known Issues

General runtime bugs (user-facing or otherwise) should be kept in the issue tracker. This section is for development issues (build process bugs, workarounds, etc).



# Links

* Environment / Release URLs
* Project Management / Issue Tracker URL
* Technology URLs to watch

README.sample.md

PROJECT NAME

One-line summary of the project.

About

Long-form about section for the project

Setup

Prerequisites

• List of everything needed
• Linkify items to their respective websites or documentation, if possible

Installation

• Any installation notes regarding the project (not the prerequisite installation)

Editing

How to edit the project.

Components

A breakdown of how the project works.

Build Process

Instructions/scripts on the build/compilation process. Include separate instructions for Continuous Integration if it differs.

Testing

Unit Tests

Instructions to execute tests and view reports. Include separate instructions for Continuous Integration if it differs.

Integration Tests

Instructions to execute tests and view reports. Include separate instructions for Continuous Integration if it differs.

Deploying

Instructions on deploying to the project to any/all applicable environments.

Notes

Known Issues

General runtime bugs (user-facing or otherwise) should be kept in the issue tracker. This section is for development issues (build process bugs, workarounds, etc).

Links

• Environment / Release URLs
• Project Management / Issue Tracker URL
• Technology URLs to watch