Homework 9: Git-ing Started

Goals

• understand the purpose of software version control.
• have created a Github account.
• have created a repo for a small project.
• have uploaded code to a repo.
• have downloaded code from a repo.

Assignment

The background material for this assignment is available here. You can read the selected chapters, or watch the videos if they exist. There are many other sources of documentation.

Do the following tasks. Please read the entire step before starting on the step.

1. Setup and Background
   • Create an account on github.
     • You may skip this step if you already have a github account.
     • You may skip this step if you are opposed to creating such an account.
     • A free public account will be fine for this class and probably most of your use for a while.
   • Read chapter 1.1 Git Basics, or watch the video.
     • 1.1 Getting Started- About Version Control
     • Git Basics Episode 1: The video is way too slow for me.
   • If you will be installing git on your home machine, go over 1.5 Getting Started - Installing Git
     • It appears git is installed on all of the linux machines.
     • But you might want to install it at home.
   • You probably want to read 1.6 Getting Started - First-Time Git Setup
2. Setting up a repo for an existing project
   • We will assume that you have an existing project you want to set up a github repo to maintain the project
   • Starting from scratch you might let github do some of the steps for you.
   • Look at these Instructions. I will step through them.
   • Create a new project.
     • On the local machine make a directory (Hello)
     • In this directory
       • Make Hello.C a program that prints "Hello World!"
       • Make a Makefile to build it.
   • Create a new repo on Github. I called mine "HelloWorld"
     • I created the repo without adding a ReadMe, or other files.
     • 
     • It then prompted me to do the following (In the directory Hello)

       
        echo "# HelloWorld" >> README.md
        git init
        git add README.md
        git commit -m "first commit"
        git remote add origin https://github.com/danbennett360/HelloWorld.git
        git push -u origin master
       
       	   

     • Step 1, just creates a file call README.md
       • echo "# HelloWorld" >> README.md
       • This step is optional.
       • Documentation on git is in a modified markup language called markdown.
       • There is a good wikipedia entry on this language.
     • Step 2, Initialize the repo
       • git init
       • You only need to do this once per repo.
       • This makes a .git directory
       • See this page for more information.
     • Step 3, Mark files you want added to your repo
       • git add Hello.C Makefile README.md
       • This line is different from the one listed on the page.
       • See here for more information.
       • You want to mark all new files for inclusion in the repo.
       • You don't want executable, object files or junk files.
       • There are many options here.
       • You will do this every time you add new files.
       • We will discuss updates later.
     • Step 4, Committing the project
       • git commit -m "first commit"
       • More information here
       • Stores contents in a new commit (locally)
       • And a comment, so you know what you did.
       • You will do this every time you want to commit changes.
     • Step 5,
       • git remote add origin https://github.com/danbennett360/HelloWorld.git
       • See the man page.
       • Connect the local repo to the remote repo.
       • You only do this once.
       • You will probably not use https://github.com/danbennett360/HelloWorld.git
       • You will probably use the web page for the repo you constructed.
       • 
     • Step 6, Upload your repo
       • git push -u origin master
       • You do this once per update.
       • You will be asked for your github username and passwd
3. Modifying the project
   • You can now go to the web page for the repo and edit files.
     • Click on the file name and look at or edit.
       • Add a new line to your "README.md"
     • Or create a new file
       • Create a LICENSE file and add the GPL
   • Downloading the changes on the local machine
     • Back on the local machine, in your project directory.
     • git pull
     • This will bring down a copy of any new or modified files.
   • Edit Hello.C and add a comment.
     • Check the status of your repo git status -s
       • This should note that Hello.C has been modified.
     • Push the new file to the repo
       • Mark Hello.C as something you want to update
         • git add -u
       • Commit it to the local repo
         • git commit -m "Comments to Hello.C"
       • Push it to github
         • git push
       • Refresh the browser and see that it is there.
   • Add a new file.
     • Create messages.C and messages.h to provide other messages.
     • Check the status
       • git status
       • Note that messages.h message.C need to be included in the project.
     • Mark these as part of the project.
       • git add messages.h messages.C
     • you probably edited other files as well, so mark them for update
       • git add -u
     • And update the entire repo
       • git commit -m "expanded for new messages"
       • git push
4. Grab a copy of a different repo.
   • Make a copy of my HelloWorld repo
     • move to the directory where you want this work to appear.
     • git clone https://github.com/danbennett360/HelloWorld
     • Smile.

• Have a working copy of your software anywhere. (just git clone)
• Give copies of your software to anyone (just send the url)
• Have groups work on a project, but there is some additional work needed.
• Have reasonable documentation and a supporting wiki.

But be aware everyone has access to this software.

• You probably do not want to put up most homework.
• You probably only want to put up quality code,
  • That is the point of this exercise, make a portfolio for future employers.

Submission

1. A subject that says CSCI 311, Homework 9.
2. A statement that you have read the material and worked through this exercise.
3. Include a link to your Hello World project repo or a statement to the effect that you do not wish to create a public github account.