Skip to content

Commit b14b32c

Browse files
committed
docs: Add references and update links
1 parent 258e78a commit b14b32c

9 files changed

+100
-12
lines changed

02-getting-ready.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,32 @@
1-
# Before you start (Required Software)
1+
# Required Software
22

3-
You will need to ensure one of the following combinations is installed:
3+
Before you start using Git you will need some software to be installed.
4+
5+
For Windows users the combination is one of:
46
- Microsoft Terminal and Git-SCM, or
57
- Microsoft Terminal and Laragon
68

7-
## Microsoft Terminal Installation
9+
For MacOS users then either:
10+
- iTerm2 & Git, or
11+
- Warp & Git
12+
13+
Mac users are able to install Git via the Git-SCM installer or via homebrew.
14+
15+
For Linux users:
16+
- Git
17+
Linux users should find git installed, if not use the package manager appropriate for your version of Linux.
18+
19+
## Windows Installations
20+
21+
### Microsoft Terminal Installation
822

923
This is a great way to interact with the command line.
1024

1125
Open the Microsoft Store, and search for "Microsoft Terminal".
1226

1327
Install the "Microsoft Terminal" version and not the preview.
1428

15-
## Git Installation
29+
### Git Installation
1630

1731
Easiest way is to download and use the Git SCM installer:
1832

@@ -22,7 +36,7 @@ Use the 64 Bit version when possible.
2236

2337
Run the installer and accept the defaults.
2438

25-
## Laragon Installation
39+
### Laragon Installation
2640

2741
Download the Full Installer from https://laragon.org/download/index.html.
2842

@@ -133,3 +147,8 @@ Finally you are able to open the new terminal by clicking on the `v` and selecti
133147
You will now have your terminal open and ready:
134148

135149
![](./assets/pasted-image-20240216111239.png)
150+
151+
152+
# Advanced Users
153+
154+
If you want to make your CLI look even cooler (more useful) then something like OhMyPosh (https://ohmyposh.dev/) may help.

04-git-started.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,13 @@ We are now ready to get started, and create a repository and work with it.
44

55
## Initialising a Repository for a 'project'
66

7-
There are three main ways to start a project. Two of them presume you have no existing files to begin with, and the third when you have files in an existing folder.
7+
There are three main ways to start a project.
8+
9+
Two of them presume you have no existing files to begin with, and the third when you have files in an existing folder.
10+
11+
- Create a folder (for the project) and initialise
12+
- Initialise with folder (project) name
13+
- Initialise with the existing folder and files
814

915
### Option 1: Create a folder then initialising
1016

@@ -13,6 +19,7 @@ Use `mkdir` command to create the folder, change into the new folder, and then u
1319
Let's presume the new project will be in the `Duck-Rogers` folder.
1420

1521
Use the `pwd` command to verify the folder:
22+
1623
![](pasted-image-20240216113101.png)
1724

1825
You see that the Windows `\` have been reversed to `/` and the `:` removed.
@@ -31,7 +38,7 @@ The command prompt will now show either `(master)` or `(main)` - if it is `maste
3138

3239
To create the `Duck-Rogers` folder and initialise in a single move, we do the following:
3340

34-
```
41+
```shell
3542
git init Duck-Rogers
3643
cd Duck-Rogers
3744
```

05-global-settings.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ git config --list --global
2424

2525
![](pasted-image-20240216124543.png)
2626

27-
### Per Project Configuration
27+
## Per Project Configuration
28+
29+
If you wish to change settings for a particular project, you can do so by using "Per Project" or "Local" configuration.
2830

2931
These need to be repeated for any project that is not going to be listed under your 'global' config.
3032

12-remotely-useful.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,43 @@ A way that we can get around this is to use a Version Control Repository that is
66

77
A Remote is a copy of Git running on a server somewhere else, usually with a GUI front end, most commonly a Web-based interface.
88

9+
There are many repository management systems run both for free and profit. It is also possible to create a self hosted web based repository management system.
10+
11+
Common (and less common) systems include:
12+
- GitHub
13+
- GitLab
14+
- BitBucket
15+
- Gitea
16+
- GNU Savannah
17+
- GitBucket
18+
- Gogs
19+
20+
# GitHub
21+
22+
## Creating a GitHub account
23+
24+
Go to https://github.com/join and on the sign-up page enter your details.
25+
26+
When doing this, there are a couple of items to note:
27+
- The username needs to be unique.
28+
- You cannot reuse an email address.
29+
- You may use a personal email address or your TAFE student email.
30+
- Do NOT make the username offensive, as many prospective employers will look at your accounts!
31+
32+
![[pasted-image-20240301120950.png]]
33+
34+
The next step requires you to verify that you are not a bot by solving a puzzle.
35+
36+
Once the puzzle is solved, you will then need to verify your email address.
37+
38+
To do this GitHub will send you and email that contains a link. Opening this link will verify your email address.
39+
40+
![[pasted-image-20240301121055.png]]
41+
42+
Once you have verified your email address, you are all done and are now able to create your very first project on GitHub.
43+
44+
![[pasted-image-20240301121111.png]]
45+
46+
47+
48+

99-references-and-resources.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# References and Resources
2+
3+
We would like to acknowledge the wide variety of resources on this subject and many others that are freely available for learners, researchers and developers.
4+
5+
Some of these resources have inspired content, others are there as they are an alternative way to look at how to use and learn version control.
6+
7+
## Bibliography
8+
9+
QuickRef.ME. (n.d.). _Git Command Cheat Sheet & Quick Reference_. [online] Available at: https://quickref.me/git [Accessed 1 Mar. 2024].
10+
11+
Stepp, M., Miller, J., Anderson, R., Wortzman, B., Fung, Z. and Matuszek, D. (n.d.). _Version Control and Git_. [online] Available at: https://homepage.divms.uiowa.edu/~sgoddard/Courses/CS2820/Lectures/1-VersionControl-and-Git.pdf [Accessed 1 Mar. 2024].

ReadMe.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
# Introduction to Version Control
22

3-
This project contains notes and exercises on using GIT for version control.
3+
This project contains notes and exercises to assist newcomers to version control to learn "Git".
44

5-
It will also include links to other resources that may assist in learning the basics of version control using git.
5+
The project is split into multiple Markdown files that cover sections of using and working with Git.
66

7-
- [01 What is Version Control](01-What-is-version-control)
7+
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/AdyGCode/Intro-to-Version-Control/total) ![GitHub commits since latest release](https://img.shields.io/github/commits-since/AdyGCode/Intro-to-Version-Control/latest)
8+
9+
10+
### Contents
11+
12+
This ReadMe does not need a Table of contents, instead we provide links to each of the Markdown files that make up this tutorial and exercises.
13+
14+
- [01 What is Version Control](01-what-is-version-control.md)
815
- [02 Getting Ready](02-getting-ready.md)
916
- [03 Repositories and Folders](03-repositories-and-folders.md)
1017
- [04 Git Started](04-git-started.md)
@@ -15,4 +22,6 @@ It will also include links to other resources that may assist in learning the ba
1522
- [09 Git History](09-git-history.md)
1623
- [10 Shaking the Tree](10-shaking-the-tree.md)
1724
- [11 Merging and Conflicts](11-merging-and-conflicts)
18-
- [12-Remotely useful](12-remotely-useful)
25+
- [12 Remotely useful](12-remotely-useful)
26+
- ...
27+
- [99 References and Resources](99-references-and-resources.md)
104 KB
Loading
140 KB
Loading
256 KB
Loading

0 commit comments

Comments
 (0)