Skip to content

Latest commit

 

History

History
63 lines (37 loc) · 1.31 KB

README.md

File metadata and controls

63 lines (37 loc) · 1.31 KB

Project's README

So you can keep asking "But why?" with the wonder of a child and dig into the deeper reason behind things.

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 have to get a development env running

Say what the step will be

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 tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Contributing

Please read CONTRIBUTING.md for details on how to contribute to this project as well as other details like our code of conduct.

See also the list of contributors who participated in this project.