#🚀 What is README.md?

README is the application's

• Overview
• Environment setup

and other information necessary for the project.
In this article, I will explain how to write an easy-to-understand README that can be found on GitHub and other sites.

#🤔 Purpose of README.md

When a new member joins a project, writing a README with an overview of the project and links to necessary documents will make it easier to understand the project and reduce unnecessary communication costs. Also, by writing the procedures for building the environment, anyone can build the development environment without relying on the technical level of each individual.

#🗒️ Content list

• Main Technologies In Use
• Overview of the project
• List of required environment variables and commands
• Directory structure
• How to build a development environment
• Troubleshooting

#Main Technologies In Use

You can kind of tell what kind of technology is being used by the directory structure, files, etc., but I put Sheild at the beginning because I felt that it might be difficult for someone who is not familiar with the technology used in the project to see it. I put "Sheild" at the beginning of the file because I felt it would be difficult for someone who is not familiar with the technology used in the project to see it.

#About Shield

Shields
Shields Icon