Skip to content

Instantly share code, notes, and snippets.

@koenkarsten

koenkarsten/README-Template.md

Forked from PurpleBooth/README-Template.md
Last active May 3, 2019 15:05
Show Gist options
  • Save koenkarsten/2723eed8d8f341849add5bf6c9181690 to your computer and use it in GitHub Desktop.
Save koenkarsten/2723eed8d8f341849add5bf6c9181690 to your computer and use it in GitHub Desktop.
Download ZIP
A template to make good README.md
Raw
README-Template.md

Project Title

One Paragraph of project description goes here.

Build Status

If possible include an indication about the build status of the project here, a badge per environment would be sufficient.

Prerequisites

Git (example)

brew install git

Java 8 (example)

........

Documentation

Supply links to available documentation about this project, for example on Confluence / Swagger.

Local Environment

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

Step 1
Step 2
Step 3

Configuration

Describe how to edit the settings of this project, and what each (or the most important) parameter(s) can be used for.

Running the tests

Unit Tests

Explain how to run the unit tests for this system

Give an example

Integration Tests

Explain how to run the integration tests for this system

Give an example

Deployment

Development Environment

Explain about how to deploy this in a development environment.

Staging Environment

Explain about how to deploy this in a staging environment.

Live Environment

Explain about how to deploy this in a live environment.

Built With

Describe the main dependencies of this project, and provide a reference to it's documentation, for example:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment