Skip to content

Instantly share code, notes, and snippets.

@p5150j
Created September 4, 2019 22:28
Show Gist options
  • Save p5150j/23d635c28f81913367a40bba353e1d34 to your computer and use it in GitHub Desktop.
Save p5150j/23d635c28f81913367a40bba353e1d34 to your computer and use it in GitHub Desktop.

Project Title

One Paragraph of project description goes here, this can be pulled from the GTM/Taglines etc

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

What things you need to install the software and how to install them

Give examples

Installing

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

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Give an examples

Deployment

Add additional notes about how to deploy and ci/cd works

Give an examples or point to deploy congfigs

Built With

Contributing

@todo pj make a CONTRIBUTING.md and update this link Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

External tools and or documents

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