https://github.com/fraction/readme-boilerplate
A template of README best practices.
https://github.com/fraction/readme-boilerplate
Last synced: 10 months ago
JSON representation
A template of README best practices.
- Host: GitHub
- URL: https://github.com/fraction/readme-boilerplate
- Owner: fraction
- License: other
- Created: 2014-06-26T23:06:50.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2022-05-06T00:01:15.000Z (about 4 years ago)
- Last Synced: 2025-04-09T23:16:11.111Z (about 1 year ago)
- Homepage:
- Size: 12.7 KB
- Stars: 91
- Watchers: 5
- Forks: 230
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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/).