Home › AI glossary › README
What is a README?
A README is the first file of a project, written to explain what it is and how to use it.
- Category GitHub & code
- Also called README.md
- Updated 20 Oct 2026
README, explained simply
The README is like the instruction sheet that comes in the box. On GitHub, it shows on the repo's main page.
A good one covers what the tool does, how to install it, and how to try it.
It is the best place to start. Read it before you download or run anything.
It is often written in Markdown, a simple way to format text.
On ITG Now, our free tool guides turn each project's README into plain steps, so you don't have to read the technical parts.
Related terms
RepoGitHubMarkdownOpen sourcegit clone
Where you'll see it on ITG Now
- GuideKarpathy autoresearch: AI That Runs Experiments Overnight
- Guidegstack: Garry Tan's Free Claude Code Skills (2026 Guide)
- GuideECC: The Free Claude Code Plugin With 311 Skills (2026)
- GuideOpenLogi: Free Logitech Options+ Alternative (2026)
- GuideCaveman: Reduce Claude Code Token Usage for Free (2026)
- GuideHeadroom: Reduce AI Token Costs for Free (2026 Guide)
Questions people ask about README
Is the README the same as documentation?
A README is the short front page. Bigger projects also have fuller documentation elsewhere.
What should I look for in a README?
Look for what the tool does, how to install it, and a license. Clear steps are a good sign.
Can I trust everything in a README?
Not blindly. Anyone can write one, so check that the repo is the real one.