Return to site

Writing a good README.md

· coding,devops

When you create a new 🆕 software project, ity should come with a README.md file.

The purpose of a README is to answer 4 questions:

  • 1️⃣ What is this project trying to achieve?
  • 2️⃣ Can I use it?
  • 3️⃣ If so, how?
  • 4️⃣ If I like it, how can I join?

 

1️⃣ Make the description 🏷️ short (3 sentences max) with this template:

is a that allows to do .

 

2️⃣ For the prerequisites 📃 , specify:

👉 Operating system

👉 Framework infrastructure

👉 Related knowledge

 

3️⃣ For the install ⚙️ howto:

👉 Demonstrate installation with commands

👉 Demonstrate usage with as many examples as possible

 

4️⃣ For the contribution 💁‍♂️ to the project:

👉 Write out a clear guideline for contributing and credit contributors

☝️ Don’t forget to add a license

 

#programming #newProject #readme #bestpractices

 

 

All Posts
×

Almost done…

We just sent you an email. Please click the link in the email to confirm your subscription!

OK