Skip to content

Instantly share code, notes, and snippets.

@durvalrafael
Created October 5, 2017 19:49
Show Gist options
  • Select an option

  • Save durvalrafael/12c22657c78e5d973c2585fb0e10ab17 to your computer and use it in GitHub Desktop.

Select an option

Save durvalrafael/12c22657c78e5d973c2585fb0e10ab17 to your computer and use it in GitHub Desktop.
README Template
	# README Boilerplate

	A template of README best practices to make your README simple to understand and easy to use. 

	## Table of Contents

	- [Installation](#installation)
	- [Usage](#usage)
	- [Support](#support)
	- [Contributing](#contributing)

	## 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 support.

	## Contributing

	Please contribute using [Github Flow](https://guides.github.com/introduction/flow/). Create a branch, add commits, and [open a pull request](https://github.com/fraction/readme-boilerplate/compare/).
	Window size: 1280 x 773
	Viewport size: 1280 x 636
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment