README: A text file at the top of a repository that explains what the project is, how to set it up and how to use it.
Example
The README lists the commands you need to run the project on your laptop.
Why README matters for IT interns
Read it first on any new project. A clear README on your own projects also makes a good impression on recruiters.
Where you will hear it
You will use this term almost daily when working on code with a team, through Git, GitHub, or a similar tool. If someone uses it and you are not sure what they mean in your project, it is completely fine to ask; every team uses terms a little differently.
Related terms
- Merge Conflict: When Git can’t combine two changes automatically because both edited the same lines, so a person has to…
- Pull: Bringing the latest changes from the shared remote repository into your local copy.
- Pull Request (PR): A Pull Request is a request to merge your code changes from one branch into another branch, usually after…
- Push: Sending your local commits to the shared remote repository so others can see them.
- Repository: A project folder tracked by Git, containing the code and its complete change history.
- Version Control: Any system that tracks changes to files over time, so you can see who changed what, go back to older versions…
Previous term: QA (Quality Assurance) | Next term: Regression Testing
Related guides
Frequently asked questions
What is README?
A text file at the top of a repository that explains what the project is, how to set it up and how to use it.
What is an example of README?
The README lists the commands you need to run the project on your laptop.
Why does README matter for IT interns?
Read it first on any new project. A clear README on your own projects also makes a good impression on recruiters.
Explore more internship terms
The IT Internship Glossary explains 199 terms you will hear before and during your internship, with simple definitions and real examples.
Browse all 199 terms