Skip to content

Readme is a documentation for creating organized documentation of any project.

Notifications You must be signed in to change notification settings

ashiishme/readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ashiish-icon

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

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.

fork this repo

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
GitHub URI       :   ashiishme

Contributors

List of all Contributors:

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 section to start contributing to this project.

Sample list below

License

License: MIT

Additional Details / References

  • Additional details to the projects or the reference to similar projects.

Changelog

CHANGELOG.md


Thank you for using this documentation. If you love this project give it a star.

star this repo

About

Readme is a documentation for creating organized documentation of any project.

Topics

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published