Writing READMEs

About this Course

Documentation is an important part of the development process. Learn to write READMEs using Markdown so your code can be used by other humans!

[

If you’ve ever written code or needed to examine somebody else’s code, you know how challenging it can be to try to make sense of a new codebase without any context.

This course will show you how to make your code more approachable to the humans who will ultimately need to make meaning of your code.

lesson 1
Writing READMEs
Learn what documentation is and who it’s for.
Learn what parts make up a great README file.
Use Markdown to write a README file quickly and easily.