---
title: "Discussion on \"A Beginners Guide to write a good README ✍\" | Hashnode"
description: "Discussion on \"A Beginners Guide to write a good README ✍\". What is a README File?\nREADME file is a guide that gives users a detailed description of a project.\nThis file should be written in brief so that any person encounters this file will get detail overview of project you work on.\nHow to Write a Good READ..."
url: "https://hashnode.com/posts/a-beginners-guide-to-write-a-good-readme/647e2f2370df99945c28685a"
---

[Feed](https://hashnode.com/feed) /

Discussion

# [A Beginners Guide to write a good README ✍](https://sayalib.hashnode.dev/a-beginners-guide-to-write-a-good-readme?utm_source=hashnode&utm_medium=feed)

What is a README File? README file is a guide that gives users a detailed description of a project. This file should be written in brief so that any person encounters this file will get detail overview of project you work on. How to Write a Good READ...

Jun 5, 2023 · 5 min read · sayalib.hashnode.dev  
Read the article

-   [#readme](https://hashnode.com/tag/readme)
-   [#readmemd](https://hashnode.com/tag/readmemd)
-   [#github-readme](https://hashnode.com/tag/github-readme)
-   [#readmemarkdown](https://hashnode.com/tag/readmemarkdown)
-   [#github-readme-language](https://hashnode.com/tag/github-readme-language)

## Written by

[Sayali Bhadang](https://hashnode.com/@SayaliBhadang)

@SayaliBhadang

  
[View profile](https://hashnode.com/@SayaliBhadang)

Devops Tech Lead |Docker|AWS

## Responses

Markdown supported · ⌘↵ to post

No responses yet.
