Goal: Now that you know how to clone repositories and how to write
README.md files, let's practice by adding
README.md files written in Markdown to the repositories you've created so far. Working as a pair, you will add a
README.md to one of each student's previous projects.
Let's add READMEs to projects that are currently in GitHub. This will give us additional practice with cloning existing repositories. All students in the pair or group of three should add a README to a project, taking their turn to drive.
If you are working on your personal computer and the project also exists on your desktop, first make sure the project is in GitHub (that means making sure that all files are saved and the latest code has been committed and pushed). Then remove the directory from your desktop. (If you're worried about losing content, you can also rename the directory). Next, clone the project down from GitHub. It’s important that we clone our existing repositories rather than just downloading the files. By using
git clone we maintain the link to the git repository and can continue to make commits to the same project.
Let's start with this:
my-first-webpage) from their account to clone and add a README to.
git cloneto clone the
my-first-webpagerepository from your GitHub.
lsin the Terminal and you should see your project folder appear.
git logto confirm that you are in the project folder and can see all of your git commits from your previous work on this project. (If this list of commits is long, you may have to press
qto get back to the command line prompt.)
git remote -vand you should see a remote link nicknamed
originto your remote repository URL. (Whenever we clone a project from GitHub the repository we cloned from is automatically included as a remote named origin).
README.mdfile by typing
my-first-webpage.htmlfile with all of your work, as well as the new, empty
README.mdfor your my-first-webpage project using the Markdown language, as discussed in the README lesson.
After you finish updating your
my-first-webpage project, the owner of the project you're currently working on will commit the new
README.md file and push the updated project back up to their GitHub using the following instructions:
$ git add .(the "
." allows you to add all files without needing to add each individually by name)
$ git commit -m "Add README"
$ git statusto ensure that everything has been committed
$ git push origin mainto push your updated project back up to GitHub
Now that you've added a
README.md to your my-first-webpage project, give the keyboard to your partner to allow your pair to do the same for one of their projects. Repeat the directions above.