DEV Community

Cover image for How To Write A Good README File
lary mak
lary mak

Posted on

How To Write A Good README File

In this article I cover the step by step guide on how to create a good README file which will give a detailed explanation to your project and make you stand out.

The quality of a README often differentiates a good project from a bad project. A good one takes advantage of the opportunity to explain and showcase:

  1. What your application does,

  2. Justify the technologies used,

  3. Talk about some of the challenges you faced and features you hope to implement in the future.
    A good README helps you stand out among the large crowd of developers putting their work on GitHub.

To read more features that you can add to your file. Please read the whole Article at my blog How to Write A Good README File

Follow my links for more Programming and development tips
Visit my blog for more: larymak's Blog
Twitter: larymak1
YouTube: TechTipsByLary
Instagram: NextGenCoders
GitHub: larymak

Discussion (1)

Collapse
epsi profile image
E.R. Nurwijayadi

How to write good markdown in dev.to

🕷 daringfireball.net/projects/markdown/