How to write an Awesome README

How to write an Awesome README

A comprehensive guide to writing README that stands out and makes people go WOW! The rest of the cool people get ready to take your first step to being a README MASTER! (absolutely not clickbait).

If you are in a hurry and just want the template skip to the bottom (not cool).

The rest of the cool people get ready to take your first step to being a *README MASTER! *(absolutely not clickbait).

You have just created this awesome project and you shared it on GitHub. You think now you’ll just sit back and wait for the world to tell you how cool your project is. After all, you have worked tirelessly for the past month on this very challenging project, right?

Well, let’s just take a step back and look from the perspective of a developer or a user checking your project. Although you know how cool your project is, and how it is going to solve that one pressing problem that hasn’t been fixed(*until you came along), *the person would be looking at your project and wondering what in the world you have built.

If nobody can’t figure out how to use your software, there’s something very bad going on.

Image for post

Photo from imgflip

If people don’t know what your software does, then they won’t use it or contribute to it and they will most likely find something more clear and concise in the sea of open-source software.

That’s where the README comes in!

A good README is like the face of your project. It is the first thing a person looks at in your project and it gives them a very brief introduction to your software.

Image for post

Beginning of the README from my NSFW Filter project

A good-looking and helpful README file can make your project stand out and grab attention from the developer community.

It will help them understand your project, how they can get it working and why they should contribute.

towards-data-science programming open-source documentation readme data science

Bootstrap 5 Complete Course with Examples

Bootstrap 5 Tutorial - Bootstrap 5 Crash Course for Beginners

Nest.JS Tutorial for Beginners

Hello Vue 3: A First Look at Vue 3 and the Composition API

Building a simple Applications with Vue 3

Deno Crash Course: Explore Deno and Create a full REST API with Deno

How to Build a Real-time Chat App with Deno and WebSockets

Convert HTML to Markdown Online

HTML entity encoder decoder Online

50 Data Science Jobs That Opened Just Last Week

Data Science and Analytics market evolves to adapt to the constantly changing economic and business environments. Our latest survey report suggests that as the overall Data Science and Analytics market evolves to adapt to the constantly changing economic and business environments, data scientists and AI practitioners should be aware of the skills and tools that the broader community is working on. A good grip in these skills will further help data science enthusiasts to get the best jobs that various industries in their data science functions are offering.

What Are The Advantages and Disadvantages of Data Science?

Online Data Science Training in Noida at CETPA, best institute in India for Data Science Online Course and Certification. Call now at 9911417779 to avail 50% discount.

Data Science Course in Dallas

Become a data analysis expert using the R programming language in this [data science]( "data science") certification training in Dallas, TX. You will master data...

Let’s talk about Open Data …

Let’s talk about Open Data : According to the International Open Data Charter(1), it defines open data as those digital data that are made available with the technical.

Data Science for Social Good: Best Sources for Free Open Data

Data Science for Social Good: Best Sources for Free Open Data. In this article, I am going through some of the most well-known and important portals that can be used in this regard.