Skip to content

Instantly share code, notes, and snippets.

@micahwalter

micahwalter/README-TEMPLATE.md

Created April 25, 2017 04:48
Show Gist options
  • Star 3 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save micahwalter/b869de7364fa186188e5aedacfce249c to your computer and use it in GitHub Desktop.
Save micahwalter/b869de7364fa186188e5aedacfce249c to your computer and use it in GitHub Desktop.
Download ZIP
Raw
README-TEMPLATE.md

Project Title

Project description goes here. This should include:

  • Is this project currently being used in production?
  • If not, what was its purpose? Is it an ongoing experiment or deprecated code?

How this Fits

  • What's the role this code plays in the org's ecosystem?

Getting Started

Instructions to get a copy of the project up and running on dev.

Prerequisites

List of software dependencies you need to install and how to install them.

Installation

Step by step instructions for getting set up to develop locally and to run on staging.

Using the Tools

List the scripts contained in the bin and what they do (if relevant).

Deployment

Notes on how/where to deploy code.

See Also

List of links to legacy documentation, articles, etc.

Built With

List of tools used and links to their docs.

[IF OPEN SOURCE...]

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

License

...

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment