Skip to content

Instantly share code, notes, and snippets.

@daniel-vera-g
Created March 15, 2021 15:47
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save daniel-vera-g/d2f8b89f6f455c69a4aabc7d1c99cda1 to your computer and use it in GitHub Desktop.
Save daniel-vera-g/d2f8b89f6f455c69a4aabc7d1c99cda1 to your computer and use it in GitHub Desktop.

Project Title

One Paragraph of project description goes here

Usage

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 (Optional)

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

Give examples

Installing and running locally

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

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 (Optional)

Explain how to run the automated tests for this system

Give an example

Deployment (Optional)

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

Documentation (Optional)

Built With (Optional)

Authors/Maintainers

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