Skip to content

Instantly share code, notes, and snippets.

@karissademi
Last active May 1, 2020 16:35
Show Gist options
  • Save karissademi/5b91ddf454ca96d7c36416685523703e to your computer and use it in GitHub Desktop.
Save karissademi/5b91ddf454ca96d7c36416685523703e to your computer and use it in GitHub Desktop.
README template

Project Title

One or two sentence of project description goes here

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.

Say what the step will be, npm install, npm run dev run test, etc.

Give the example - npm install

And repeat

until finished - npm run dev 

End with example of the data, or what should happen if successful run.

Running the tests

Explain how to run the automated tests for this system.

Add coding style tests and explain those (if applicable).

Break down into end to end tests (if they exist)

What do the tests do and why?

Give an example

And coding style tests

Explain what these tests test and why (if applicable).

Give an example

Deployment

How (travis, github actions, etc)? What branches have CI/CD (if applicable)?

Versioning

Do we use semver (it should)? If not, what?

License

This project is licensed under the MIT License - see the LICENSE file for details

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