Skip to content

Instantly share code, notes, and snippets.

@SalahHamza

SalahHamza/writing_readmes.md

Last active November 6, 2018 01:48
Show Gist options
  • Save SalahHamza/9bc969dbcd9444ee23705bc267d4801a to your computer and use it in GitHub Desktop.
Save SalahHamza/9bc969dbcd9444ee23705bc267d4801a to your computer and use it in GitHub Desktop.
Download ZIP
udacity's Writing READMEs course Notes (ud777)
Raw
writing_readmes.md

Writing READMEs

Anatomy of a README

When writing a README for a project, make sure to ask yourself these questions:

  • what steps need to be taken to get this code base up and running?
  • what should the user already have installed or configured?
  • what might they have a hard time understanding right away?

A Getting Started or Installation section is often added to help with initial setup that may need to happen before using your code.

Common Sections in a README

Licence

By default you retain all the rights to your code, even if you don't include a license, but it's a safer bet to be explicit.

Check here to get help choosing a license.

Contribution

Is a section to briefly provide simple steps, a style guide or whatever information you want others to know about contributing is a great way to make your project more accessible for those wanting to help.

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