Skip to content

Instantly share code, notes, and snippets.

@chimericdream
Forked from mcgwier/readme
Last active August 29, 2015 14:24
Show Gist options
  • Save chimericdream/1e94d899830457edf29f to your computer and use it in GitHub Desktop.
Save chimericdream/1e94d899830457edf29f to your computer and use it in GitHub Desktop.
# README Boilerplate
A template of README best practices to make your README simple to understand and easy to use.
## Installation
Download to your project directory, add `README.md`, and commit:
```sh
curl -LO http://git.io/Xy0Chg
git add README.md
git commit -m "Use README Boilerplate"
```
## Usage
Replace the contents of `README.md` with your project's:
* Name
* Description
* Installation instructions
* Usage instructions
* Support instructions
* Contributing instructions
Feel free to remove any sections that aren't applicable to your project.
## Support
Please [open an issue](https://github.com/fraction/readme-boilerplate/issues/new) for questions and concerns.
## Contributing
Fork the project, commit your changes, and [open a pull request](https://github.com/fraction/readme-boilerplate/compare/).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment