Skip to content

Writing READMEs

Free Course

Because Code is for Humans, Too

Related Nanodegree Program

Front End Web Developer

About this course

In this course, you’ll learn what documentation is and why it’s an important part of the development process. You'll learn how to build a well-structured README that you’ll be able to incorporate into your projects moving forward. By the end of this course, you will have written your very own README file using Markdown.

What you will learn

  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.

Prerequisites and requirements

This course is for anybody who writes code or works with others who do. The only prerequisites are:

  • A basic understanding of HTML
  • A basic understanding of git and GitHub (helpful, but not required!)

See the Technology Requirements for using Udacity.

Why take this course?

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.

Learn with the best.

  • Walter Latimer
    Walter Latimer