Skip to content

Instantly share code, notes, and snippets.



Created Jul 26, 2020
What would you like to do? how to write it following Best practices


This gist is about a collection of lectures about how to write a good README

01. introduction

02. What's documentation

03. Why Should Art Have Documented His Code? ( Director of Engineering)

04. Intro to READMEs

05. Anatomy of README

06. Documenting a Growing Codebase

07. Readable READMEs with Markdow

08. Documente everything

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.