Readme

Readme is the documentation for creating organized documentation of any project. The logo size used for this documentation is 200 x 150 size. Go through the installation section to start using this documentation for your project. If you have many contents, start with the Table Of Contents.

The project comes with a Code Of Conduct, Contributing and Changelog file to help you make your documentation more in-depth.

Table Of Contents

• Prerequisites
• Installation
• Demo
• Tests
• Author
• Contributors
• Contribution
• License
• Additional Details / References
• Changelog

Prerequisites

If your project needs any prerequisites or dependencies, list them here.

Example to install dependencies

Installation

Download the readme file using wget / curl and start editing according to your need.

wget https://raw.githubusercontent.com/askbuddie/readme/master/README.md -O README.md

curl https://raw.githubusercontent.com/askbuddie/readme/master/README.md > README.md

You can fork the project.

Fork

You can clone the whole project.

git clone https://github.com/askbuddie/readme.git

Demo

Add demo of the projects. It can be any format ( link | image | gif | video ).

Tests

There are no test avaiable for this project. Details about the necessary of test can be very useful.

Author

Author Name   :   Ashish Yadav
Author URI       :   www.ashiish.me
GitHub URI       :   ashiishme

Contributors

List of all Contributors:

• contributor name

Contribution

This project is to help Individuals / organization to quickly setup a documentation or readme. If you want to contribute, pull requests are always welcome.Pull request to add features rules.

• Fork the project
• Add a feature-branch and add your features
• Send pull request and wait to merge.

Check the installation section to start contributing to this project.

Sample list below

• CODE OF CONDUCT
• CONTRIBUTING

License

Additional Details / References

• https://github.com/ashiishme/readme/

Changelog

CHANGELOG.md