Skip to content

Instantly share code, notes, and snippets.

@abdennour

abdennour/README.md

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

Overview

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

01. introduction

https://youtu.be/zYyRDFx3e28

02. What's documentation

https://youtu.be/IgOMI4_wQ54

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

https://youtu.be/EBZxpavWMjk

04. Intro to READMEs

https://youtu.be/7ZHhSSBUzoI

05. Anatomy of README

https://youtu.be/i602s2RxWR0

06. Documenting a Growing Codebase

https://youtu.be/4sU1LZksOH4

07. Readable READMEs with Markdow

https://youtu.be/rWGxZGRwuAM

08. Documente everything

https://youtu.be/-rrim56YdmY

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment