Readme: What should be included? Simple list #1553
Unanswered
ghost
asked this question in
Show and tell
Replies: 1 comment
-
Hope you found it interesting and useful! |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
I made myself an awesome readme. I read many blogs on the web. Here is a simple list of what to add in a readme
Check The Example Below To Know More
Features In A More Attractive Way
What Does Your Project Do
Comparision
Demo
Quick Start
Templates
Installation Guidelines
Usage
Deployment: Optional
FAQ
Documentation
Check The Example Below To Know More
Roadmap
Feedback
Authors
All Contributors
Check The Example Below To Know More
Check The Example Below To Know More
Copy All Contents Of Your License In A Code Block
Project Status
Eg: https://github.com/krishdevdb/reseter.css
Few Sections Are Not There Yet. Will Be There Soon
Beta Was this translation helpful? Give feedback.
All reactions