A crash course on writing a better READMEby@adnanrahic
4,232 reads

A crash course on writing a better README

tldt arrow
Read on Terminal Reader
Read this story w/o Javascript

Too Long; Didn't Read

The open-source community has opened over 400 000 pull requests during October alone. The pillar of any open source project is the readme.md file. It contains all necessary information for understanding the direction the project is heading. The most important part is that it contains steps to get the software running on your local machine for development purposes. But, it should also contain steps to deploy the software to production as well. Make A Readme walks you through the whole process of writing an awesome readme.

Companies Mentioned

Mention Thumbnail
Mention Thumbnail

Coin Mentioned

Mention Thumbnail
featured image - A crash course on writing a better README
Adnan Rahić HackerNoon profile picture

@adnanrahic

Adnan Rahić

Senior Developer Advocate @ Tracetest.io. Book/Course Author. Failed startup founder and ex-freeCodeCamp local leader.


Receive Stories from @adnanrahic

react to story with heart

RELATED STORIES

L O A D I N G
. . . comments & more!