AI Hints
Home›Git & GitHub Tutorial›Pushing to GitHub
Git & GitHub · Lesson 58 of 144

A README

Your project's front page.

⏱ 2 min read▶ Video at 1:03:04🎓 Free
Watch this lesson in the Git & GitHub courseWatch on YouTube ↗Full Git & GitHub course

When someone opens your repository on GitHub, the first thing they see is the readme file. It's your project's front page. It explains what the project is, and how to use it.

A README
From the video: A README
  • The first thing visitors see
  • Your project's front page
  • What it is, how to use it

README.md

Readme files are written in markdown, a simple way to format text. A hash sign makes a big heading. Two hash signs make a smaller heading. A dash starts a bullet point. Two stars make text bold. And square brackets, followed by round brackets, make a link.

README.mdmarkdown
# My Site

My personal website, built while learning Git.

## Pages
- **Home**: index.html
- **About**: about.html

Made by [Sam](https://github.com/sam).

Pushing the README

We save the file, add it, commit it, and push. On GitHub, it now appears right below the list of files, nicely formatted.

git
git add README.md
git commit -m "Add README"
[main a6e9e09] Add README
 1 file changed, 9 insertions(+)
 create mode 100644 README.md
git push
To https://github.com/sam/my-site.git
   f63a17a..a6e9e09  main -> main

Summary

A readme, written in markdown, is your project's front page on GitHub. Next, getting a copy of a repository from GitHub.

Key takeaways
  • README.md
  • # heading, - bullet, **bold**
  • Shown on the repo's page
Next up: Cloning a Repository — git clone