https://github.com/ashiishme/readme
Readme is a documentation for creating organized documentation of any project.
https://github.com/ashiishme/readme
readme readme-bolierplate readme-md readme-template
Last synced: 3 months ago
JSON representation
Readme is a documentation for creating organized documentation of any project.
- Host: GitHub
- URL: https://github.com/ashiishme/readme
- Owner: ashiishme
- Created: 2019-06-26T06:08:09.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-06-26T11:45:17.000Z (almost 6 years ago)
- Last Synced: 2025-01-14T08:37:01.989Z (5 months ago)
- Topics: readme, readme-bolierplate, readme-md, readme-template
- Homepage:
- Size: 79.1 KB
- Stars: 18
- Watchers: 2
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Readme
Readme is a documentation for creating organized documentation of any project. The logo size used for this documentation is `150 x 150` size. Go through the installation section to start using this documentation for your project. If you have many contents, start with Table Of Contents.
The project comes with Code Of Conduct, Contributing and Changelog file to help you make your documentation more in depth.
## Table Of Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Demo](#demo)
- [Tests](#tests)
- [Author](#author)
- [Contributors](#contributors)
- [Contribution](#contribution)
- [License](#license)
- [Additional Details / References](#additional-details--references)
- [Changelog](#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/ashiishme/readme/master/README.md -O README.md
```
```
curl https://raw.githubusercontent.com/ashiishme/readme/master/README.md > README.md
```
You can `fork` the project.
[](https://github.com/ashiishme/readme/fork)
You can clone the whole project.
```
git clone https://github.com/ashiishme/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](https://www.ashiish.me)
**GitHub URI** : [ashiishme](https://github.com/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.
Check the [installation](#installation) section to start contributing to this project.
**Sample list below**
- [CODE OF CONDUCT](CODE_OF_CONDUCT.md)
- [CONTRIBUTING](CONTRIBUTING.md)
## License
[](https://opensource.org/licenses/MIT)
## Additional Details / References
- Additional details to the projects or the reference to similar projects.
## Changelog
[CHANGELOG.md](CHANGELOG.md)
---
Thank you for using this documentation. If you love this project give it a star.
[](https://github.com/ashiishme/readme)