Skip to content

Instantly share code, notes, and snippets.

@tmaslen

tmaslen/Example-Readme.md

Last active October 8, 2019 08:06
Show Gist options
  • Save tmaslen/184db4664c4f02f9b0c2bc4551150726 to your computer and use it in GitHub Desktop.
Save tmaslen/184db4664c4f02f9b0c2bc4551150726 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Example-Readme.md

Project Title

One Paragraph of project description goes here

Overview

Top 5 things about this project

  • List of them

High level diagram (component diagram)

  • Any specific points of interest

description of the relationship

Data sources

Indepth description of any data sources

Consuming services

  • List all services that consume this with a brief

Getting Started

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.

Prerequisites

List of global dependencies and instructions on installation

Give examples

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

End a smoke test to prove project is running locally

Start project
URL of project

Example events

Quick example of how to interact with the system manually.

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

Deploying

Instructions on how to deploy

Scripts

Document any helper scripts the project has in /scripts.

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