|
# Finding your way with Git
|
|
This document outlines some basic elements of _finding your way with Git_, especially in the context of our workflow in the Optimisation Group. You can also have a look at the following three-part video that was recorded for one of our final-year groups:
|
|
|
|
|
|
This document outlines some basic elements of Git, especially in the context of
|
|
|
|
our workflow in the Optimisation Group. You can also have a look at the following three-part video that was recorded for one of our final-year groups:
|
|
|
|
* [Part 1](https://youtu.be/HNfnRKFHfXs)
|
|
* [Part 1](https://youtu.be/HNfnRKFHfXs)
|
|
* [Part 2](https://youtu.be/0XzOJza913E)
|
|
* [Part 2](https://youtu.be/0XzOJza913E)
|
|
* [Part 3](https://youtu.be/yHmcmKgECCc)
|
|
* [Part 3](https://youtu.be/yHmcmKgECCc)
|
... | @@ -11,31 +8,18 @@ folders with specific examples. You are always welcome to check out this project |
... | @@ -11,31 +8,18 @@ folders with specific examples. You are always welcome to check out this project |
|
create a new branch, contribute to it, and send [me](@jwjoubert) a merge request...
|
|
create a new branch, contribute to it, and send [me](@jwjoubert) a merge request...
|
|
don't know what _that_ is (yet)? Read on.
|
|
don't know what _that_ is (yet)? Read on.
|
|
|
|
|
|
|
|
On this page you will find the basic building blocks:
|
|
[[_TOC_]]
|
|
[[_TOC_]]
|
|
|
|
|
|
## Contents
|
|
|
|
|
|
|
|
* **[First you need Git](#first-you-need-git)**
|
|
|
|
|
|
|
|
* **[Windows](#windows)**
|
|
|
|
* **[Mac OS](#mac-os)**
|
|
|
|
* **[Linux](#linux)**
|
|
|
|
|
|
|
|
* **[The typical Git workflow](#the-typical-git-workflow)**
|
|
|
|
|
|
|
|
* **[Integrating Git with your documents](#integrating-git-with-your-documents)**
|
|
|
|
|
|
|
|
* **[A quick and dirty way to getting started with Git](#a-quick-and-dirty-way-to-getting-started-with-git)**
|
|
|
|
|
|
|
|
***
|
|
***
|
|
|
|
|
|
## First you need Git
|
|
# First you need Git
|
|
|
|
|
|
To be able to work with Git, you will need Git itself and also (for ease of use)
|
|
To be able to work with Git, you will need Git itself and also (for ease of use)
|
|
a _Git client_. The following subsections highlights the main steps for the
|
|
a _Git client_. The following subsections highlights the main steps for the
|
|
different platforms:
|
|
different platforms:
|
|
|
|
|
|
### Windows
|
|
## Windows
|
|
|
|
|
|
Because we always feel sorry for the poor Windows users we will start with them.
|
|
Because we always feel sorry for the poor Windows users we will start with them.
|
|
The first step would be to download Git itself, and you can get it
|
|
The first step would be to download Git itself, and you can get it
|
... | @@ -49,7 +33,7 @@ Windows I recommend [TortoiseGit](https://tortoisegit.org), although there are |
... | @@ -49,7 +33,7 @@ Windows I recommend [TortoiseGit](https://tortoisegit.org), although there are |
|
|
|
|
|
You should now be ready to _git_ going.
|
|
You should now be ready to _git_ going.
|
|
|
|
|
|
### Mac OS
|
|
## Mac OS
|
|
|
|
|
|
For Mac I suggest you use [macports](https://www.macports.org) to install
|
|
For Mac I suggest you use [macports](https://www.macports.org) to install
|
|
Git. The version of Git that ships with Mac OS is quite old. Once you have
|
|
Git. The version of Git that ships with Mac OS is quite old. Once you have
|
... | @@ -90,7 +74,7 @@ training material on using Git. Although the material is free online content, it |
... | @@ -90,7 +74,7 @@ training material on using Git. Although the material is free online content, it |
|
is structured around Tower, so users of other [Git GUI clients](https://git-scm.com/download/gui/linux)
|
|
is structured around Tower, so users of other [Git GUI clients](https://git-scm.com/download/gui/linux)
|
|
may have to adapt the training material to their GUI of choice.
|
|
may have to adapt the training material to their GUI of choice.
|
|
|
|
|
|
### Linux
|
|
## Linux
|
|
|
|
|
|
Getting git may be distribution specific, but the following should work on the
|
|
Getting git may be distribution specific, but the following should work on the
|
|
command line/Terminal of Ubuntu.
|
|
command line/Terminal of Ubuntu.
|
... | @@ -103,7 +87,7 @@ It actually has Windows and Mac versions too. |
... | @@ -103,7 +87,7 @@ It actually has Windows and Mac versions too. |
|
|
|
|
|
***
|
|
***
|
|
|
|
|
|
## The typical Git workflow
|
|
# The typical Git workflow
|
|
|
|
|
|
The following image shows a typical Git workflow.
|
|
The following image shows a typical Git workflow.
|
|
|
|
|
... | @@ -173,13 +157,13 @@ where `origin` indicates the remote, central repository, and `master` the branch |
... | @@ -173,13 +157,13 @@ where `origin` indicates the remote, central repository, and `master` the branch |
|
If you want more info on Markdown documents, look [here](https://github.com/gitlabhq/gitlabhq/blob/master/doc/markdown/markdown.md).
|
|
If you want more info on Markdown documents, look [here](https://github.com/gitlabhq/gitlabhq/blob/master/doc/markdown/markdown.md).
|
|
|
|
|
|
|
|
|
|
## Integrating Git with your documents
|
|
# Integrating Git with your documents
|
|
|
|
|
|
A neat feature working in LaTeX is that you can add a watermark to the footer of
|
|
A neat feature working in LaTeX is that you can add a watermark to the footer of
|
|
your document, for example, which shows who the last person is to commit to the
|
|
your document, for example, which shows who the last person is to commit to the
|
|
document and what the specific revision is. More information on setting that up
|
|
document and what the specific revision is. More information on setting that up
|
|
and getting it done [here](https://ie-repo.up.ac.za/howto/welcome/tree/master/latex).
|
|
and getting it done [here](https://ie-repo.up.ac.za/howto/welcome/tree/master/latex).
|
|
|
|
|
|
## A quick and dirty way to getting started with Git
|
|
# A quick and dirty way to getting started with Git via GUI
|
|
|
|
|
|
If you've made it this far the [following video](https://youtu.be/4bF6k0RDHxU) shows a quick and dirty way of getting up and running with git using the [SourceTree](https://www.sourcetreeapp.com) GUI. |
|
If you've made it this far the [following video](https://youtu.be/4bF6k0RDHxU) shows a quick and dirty way of getting up and running with git using the [SourceTree](https://www.sourcetreeapp.com) GUI. |
|
|
|
\ No newline at end of file |