Setting Up a Local Git Repository

Getting Started

• To install git on your machine, head to their website.
• Check whether git has been installed successfully.

  > git --version
  git version 2.18.2

• Set up your name and email.
  

  > git config --global user.name "Roo Biki"
  > git config --global user.email "doggo4orce@gmail.com"

• Check that this has been set up correctly.
  

  > git config --list
  user.name=Roo Biki
  user.email=doggo4orce@gmail.com

• To see the list of options to configure, see the manual.
  

  > git config --help

Initializing a Bare Repository from Existing Code

• Make a folder to store your local repos. Place a copy of your working directory within this folder. As you can see I have a fresh copy of mud-pi.
  

  > pwd
  /home/doggo/repos
  > ls
  drwxrwxr-x 2 doggo doggo 4096 Mar  1 06:18 mudpi/
  > cd mudpi
  > ls
  -rwxrwxr-x 1 doggo doggo  1069 Mar  1 06:18 licence.md*
  -rwxrwxr-x 1 doggo doggo 16307 Mar  1 06:18 mudserver.py*
  -rwxrwxr-x 1 doggo doggo  5845 Mar  1 06:18 README.md*
  -rwxrwxr-x 1 doggo doggo  8935 Mar  1 06:18 simplemud.py*

• In the working directory of your project, initialize git.

  > git init
  Initialized empty Git repository in /home/doggo/repos/mudpi/.git/

• If you ever want to completely remove git from your project, it is as easy as typing a single command (from the same location).

  > rm -rf .git

• Note that none of your files are being tracked at the start.

  > git status
  On branch master
  
  No commits yet
  
  Untracked files:
  
    (use "git add <file>..." to include in what will be committed)
  
          README.md
          licence.md
          mudserver.py
          simplemud.py
  
  nothing added to commit but untracked files present (use "git add" to track)

• Add all four files to the repository.

  > git add README.md licence.md mudserver.py simplemud.py

• Afterwards, all the files are now being tracked.
  

  > git status
  On branch master
  
  No commits yet
  
  Changes to be committed:
    (use "git rm --cached <file>..." to unstage)
  
  	new file:   README.md
  	new file:   licence.md
  	new file:   mudserver.py
  	new file:   simplemud.py

• Since the repository is still technically empty, all of the files are still interpreted as changes. If you wanted to stop tracking a file, say README.md, use the following command.

  > git reset README.md

• Commit the changes.

  > git commit -m "Initial Commit"
  [master (root-commit) 2462ac2] Initial Commit
   4 files changed, 804 insertions(+)
   create mode 100755 README.md
   create mode 100755 licence.md
   create mode 100755 mudserver.py
   create mode 100755 simplemud.py

• This shall be a bare repository, in which no modifications are made directly. The hidden folder .git contains the blueprint for the repository, and will replace the source files, which will then be deleted.

  > git config --bool core.bare true
  > mv .git ../mudpi.git
  > cd ..
  > rm -rf mudpi

Cloning the Repository

• Navigate to a directory where you want your work to take place, and make a clone of the repository.

  > cd ~/clones
  > git clone ~/repos/mudpi.git
  Cloning into 'mudpi'...
  done.