kadirgombel / readme-boilerplate

Boilerplate for creating github compatible readme files

Readme Boilerplate

Boilerplate for creating github compatible readme files

Background

Creating a good README.md takes forever, especially if you are starting off from scratch. So, I decided to make a few templates to help me speed up things a little bit. The readme-template.md file is a template containing a group of sections that you might want to include on your readme file.

Installation

Open your terminal and type in

$ git clone https://github.com/Yilber/readme-boilerplate.git
$ cd readme-boilerplate

Scaffolding

readme-boilerplate
├── src
│   └── templates
│       ├── header-advanced.md
│       ├── header-simple.md
│       └── readme-template.md
├── LICENSE
└── README.md

How to use

• Create a README.md file.
• Pick a header from the templates folder and copy its content onto the README.md file.
• Update the URLs and add/remove any necessary badge.
• Copy and paste the content from the readme-template.md onto the README.md file.
• Add/remove necessary sections and update all URLs.

Bugs

If you have questions, feature requests or a bug you want to report, please click here to file an issue.

Author

• Yilber Mejia

Support

Like what you see? Keep me awake at night by buying me a coffee or two.

License

Copyright (c) 2019 Yilber Mejia.

Usage is provided under the MIT License. See LICENSE for the full details.