Posted on 2/12/2024
A README file is important for any project, seems like a minor detail but it’s a great way to introduce your project to the world and insure that it is being used properly.
There’s three ways to add a README file to your GitHub repo:
This tutorial will cover the third option.
💡 If you want to add a README file to someone else’s project and don’t know where to start; read Clone, edit and push to GitHub then come back to this article after you’ve cloned the repo.
Here are some basic things you can include in your README file:
git clone https://github.com/sulamitaivanov/hoverEffect
Open your terminal đź’ˇ Use the search on your computer to find it.
Access the location and folder where your project is located. In this example, my project is located on my Desktop and a folder called new-project.
cd Desktop/new-project
đź’ˇIf it is a folder within a folder, add another forward slash and the next folder name. Repeat until you get to the root folder of your project.
git init
git status
Git status is always optional but good practice. Check the status of your files, it will show you which files have been modified, added or deleted.
git add README.md
git status
git commit -m "added README file"
git remote add origin https://github.com/sulamitaivanov/hovereffect.git
git push -u origin main
You can now refresh the page and see your README file on GitHub! 🎉