Skip to content

Instantly share code, notes, and snippets.

@abraidotti

abraidotti/ks-readme-template.md

Last active September 28, 2020 14:43
Show Gist options
  • Save abraidotti/e6c7d164ee2a30367116155f0f66758d to your computer and use it in GitHub Desktop.
Save abraidotti/e6c7d164ee2a30367116155f0f66758d to your computer and use it in GitHub Desktop.
Download ZIP
Kintyre README template
Raw
ks-readme-template.md

Product Name

what does this product do?

Table of Contents

General info

Add more general information about project.

Requirements

To use this product, do these things first.

Installation

Do these things.

Setup

Other files needed? API keys? Profiles and passwords? URLs? Stages?

Deployment

Where will this product live? What will need to be hooked up to it?

Testing

Instructions to test this product

Contribution

Instructions to contribute code

Context

What else should a user know about this product?

Contact

Who can answer questions about this product?

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