-
Notifications
You must be signed in to change notification settings - Fork 231
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit c960f2b
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# README Boilerplate | ||
|
||
A collection of best practices for a simple and informative README. | ||
|
||
## Installation | ||
|
||
Download to your project directory, add it, and commit. | ||
|
||
```sh | ||
curl -O https://github.com/christianbundy/readme-boilerplate.md | ||
git add README.md | ||
git commit -m "Add README Boilerplate" | ||
``` | ||
|
||
## Usage | ||
|
||
Edit `README.md` with the name of your project, a description, installation instructions, usage instructions, how to get support, and how people can contribute to your project. | ||
|
||
## Support | ||
|
||
Please open an issue to receive support for this project. | ||
|
||
## Contributing | ||
|
||
Fork the project, create a new branch, make your changes, and open a pull request. |