blob: 3a0976ce332320aaccc6c5b3cc7198e948e108b6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
# 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
- Licence
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/).
|
