Creating a README

Introduction to GitHub Concepts

Jasmin Ludolf

Content Developer, DataCamp

Edit the README

View of the soccer analysis repo

Introduction to GitHub Concepts

Edit the README

View of the soccer analysis repo with the README file highlighted

Introduction to GitHub Concepts

Edit the README

View of the soccer analysis repo with the pencil icon to edit the README file highlighted

Introduction to GitHub Concepts

Markdown

View of the README file

Introduction to GitHub Concepts

Edit vs. Preview

View of the README file highlighting the edit and preview tabs

Introduction to GitHub Concepts

Headings

View of a markdown file edit page with syntax for the largest heading

View of a markdown file preview page with the largest heading

Introduction to GitHub Concepts

Headings

View of a markdown file edit page with syntax for all six heading types

View of a markdown file preview page with all six heading types

Introduction to GitHub Concepts

Headings

View of a markdown file edit page with syntax for all six heading types]

View of a markdown file preview page with all six heading types and arrows pointing to the lines under heading one and heading two

Introduction to GitHub Concepts

Text formatting

View of a markdown file edit page with syntax for bold and italics

View of a markdown file preview page with bold and italic text

Introduction to GitHub Concepts

Hyperlinks

View of a markdown file edit page with syntax for a hyperlink

View of a markdown file preview page with a hyperlink

Introduction to GitHub Concepts

Hyperlinks

Animated view of clicking a hyperlink

Introduction to GitHub Concepts

Images

Animated view dragging an image into the markdown file and GitHub automatically rendering the syntax

Introduction to GitHub Concepts

Writing a README

  • Need to be descriptive
    • Anyone should understand our project
  • List the contents of the repository
  • Clearly explains the project to others

Illustration of an open book

Introduction to GitHub Concepts

README fundamentals

  • Title
  • Description of technology
    • Why?
  • Description of the process
    • Why?
  • Table of contents
Introduction to GitHub Concepts

README extras

  • How the project came about
  • The motivation
  • Limitations
  • Challenges
  • What problem it hopes to solve
  • What the intended use is
  • Credits
Introduction to GitHub Concepts

Let's practice!

Introduction to GitHub Concepts

Preparing Video For Download...