init: Create Version Control Notes Project

Author: Ady-Gould

.gitignore

@@ -0,0 +1,17 @@
+
+
+# What is version Control
+
+## The Past
+
+
+## The Present
+
+
+## Types of Version Control System
+
+
+
+## Distributed Version Control
+
+

01-What-is-Version-Control.md

@@ -0,0 +1,135 @@
+# Before you start (Required Software)
+
+You will need to ensure one of the following combinations is installed:
+- Microsoft Terminal and Git-SCM, or
+- Microsoft Terminal and Laragon
+
+## Microsoft Terminal Installation
+
+This is a great way to interact with the command line.
+
+Open the Microsoft Store, and search for "Microsoft Terminal".
+
+Install the "Microsoft Terminal" version and not the preview.
+
+## Git Installation
+
+Easiest way is to download and use the Git SCM installer:
+
+https://git-scm.com/download/win
+
+Use the 64 Bit version when possible.
+
+Run the installer and accept the defaults.
+
+## Laragon Installation
+
+Download the Full Installer from https://laragon.org/download/index.html.
+
+Run the installer and accept the defaults.
+
+This places Laragon in the folder `c:\Laragon`.
+
+# The CLI
+
+CLI stands for Command Line Interpreter.
+
+There are many of them including:
+- Windows Command Prompt
+- Microsoft PowerShell
+- bash 
+- zshell
+- and many more
+
+## Parts of the Prompt
+
+| Image | Description |
+| ---- | ---- |
+| ![[Pasted image 20240216111739.png]] | This is the user account, followed by the computer name and separated by an `@`<br><br>Literally: *User **at** Computer*<br>  |
+| ![[Pasted image 20240216111840.png]] | Tells us that we are running in MinGW 64 bit<br>  |
+| ![[Pasted image 20240216111909.png]] | Shows we are in the `~/Source/Repos` folder, where `~` is the user's (your) home folder.<br><br>In Windows terms, this is the same as:<br><br>  `C:\Users\UserName\Source\Repos`<br>  |
+
+## Setting up Microsoft Terminal to use Git Bash as a CLI
+
+Open MS Terminal.
+
+Click on the `v`  (or press `CTRL`+`,`) on the tab bar.
+
+Click *Settings*...
+
+![[Pasted image 20240216103325.png]]
+
+Click on *Add a new profile*...
+
+![[Pasted image 20240216103615.png]]
+
+Click *New Empty Profile*...
+
+![[Pasted image 20240216103644.png]]
+
+Click on the `v` next to the "*Profile x*"...
+
+![[Pasted image 20240216103947.png]]
+
+And give the profile a name...
+
+![[Pasted image 20240216103833.png]]
+
+Next find the *Command Line* entry and click on the `v`
+
+![[Pasted image 20240216104034.png]]
+
+Then click the *Browse* button...
+
+![[Pasted image 20240216104105.png]]
+
+At home, if you have installed using Git-SCM installer then the default location for Git is: `c:\program files\git`. If you have Laragon installed using the default installation location, then you should find Git in the `C:\Laragon\bin\git` folder.
+
+> At TAFE, we have a different location, `c:\ProgramData\git` or even `C:\ProgramData\Laragon\bin\git`.
+
+Use the browse to locate the folder and find either the `git.exe` or the `bash.exe` file in the `bin` folder.
+
+![[Pasted image 20240216105026.png]]
+
+Click on the Starting Directory `v` and then untick the "*Use parent process directory*"...
+
+![[Pasted image 20240216105847.png]] 
+This should then show `%USERPROFILE%` in a text field and `Browse` button underneath... 
+
+![[Pasted image 20240216105903.png]]
+
+No matter what is shown, clear the content and enter the following in its place...
+
+`%USERPROFILE%\Source\Repos`
+
+![[Pasted image 20240216110033.png]]
+
+Click `SAVE` to save the changes
+
+### Visual flair (optional)
+You may optionally customise the appearance of the terminal. 
+
+Adrian tends to do this to visually identify the various prompts.
+
+The steps below are optional, and you may vary to your own "taste".
+
+Click the *Appearance* item.
+
+![[Pasted image 20240216110837.png]]
+
+You may change the base colour scheme, the font face and more.
+
+Here are the settings Adrian has for this terminal prompt:
+
+![[Pasted image 20240216110957.png]]
+
+Click Save then you can click the `X` next to settings to close the dialog.
+![[Pasted image 20240216111033.png]]
+
+Finally you are able to open the new terminal by clicking on the `v` and selecting your custom terminal or using the short-cut it shows on the right next to your custom terminal.
+
+![[Pasted image 20240216111111.png]]
+
+You will now have your terminal open and ready:
+
+![[Pasted image 20240216111239.png]]

02-getting-ready.md

@@ -0,0 +1,35 @@
+# Repositories and Folders
+
+Projects are contained in a folder in your user's root/home folder.
+
+This folder is the `Source/Repos` folder.
+
+If you do not have this folder then the steps below should be followed.
+
+## Creating a `Source/Repos` folder structure for projects
+
+Open Terminal and then click the `v` next to the `+` on the tab bar.
+
+Select the *Command Prompt* option
+
+![[Pasted image 20240216105215.png]]
+
+When the terminal opens use the following commands to change into your "user home" and make the `Source\Repos` folder.
+
+> **Important:** We tend to use the forward slash `/` in notes as they show up easily, plus most operating systems other than Windows use the `/` as the folder separator. 
+> 
+> Later you will see this in action when using the Git command line.
+
+Here are the commands to use:
+```shell
+cd %userprofile%
+mkdir Source 
+mkdir Source\Repos
+```
+You should now have the folders created.
+
+Check this using:
+```shell
+dir Source\Repos
+```
+It should show a folder listing with no files.

03-repositories-and-folders.md

@@ -0,0 +1,64 @@
+# Git Started
+
+We are now ready to get started, and create a repository and work with it.
+
+## Initialising a Repository for a 'project'
+
+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.
+
+### Option 1: Create a folder then initialising
+
+Use `mkdir` command to create the folder, change into the new folder, and then using the `git init .` command.
+
+Let's presume the new project will be in the `Duck-Rogers` folder.
+
+Use the `pwd` command to verify the folder:
+![[Pasted image 20240216113101.png]]
+
+You see that the Windows `\` have been reversed to `/` and the `:` removed.
+
+```shell
+mkdir Duck-Rogers
+cd Duck-Rogers
+git init .
+```
+
+![[Pasted image 20240216113320.png]]
+
+The command prompt will now show either `(master)` or `(main)` - if it is `master`, we will show you later how to (a) change it to `main` for the current project and (b) to make `main` the default.
+
+### Option 2: Initialise project and folder at same time
+
+To create the `Duck-Rogers` folder and initialise in a single move, we do the following:
+
+```
+git init Duck-Rogers
+cd Duck-Rogers
+```
+
+![[Pasted image 20240216113649.png]]
+
+![[Pasted image 20240216113804.png]]
+
+### Option 3: Initialise project with existing files
+
+The best part of this is that you are basically able to use the previous options, except the folder already exists.
+
+For example, if `Duck-Rogers` already exist and has files, then, if we are at the parent folder for  Duck-Rogers we can use the `git init Duck-Rogers` command.
+
+![[Pasted image 20240216114404.png]]
+
+If you are in the `Duck-Rogers` folder and there are files in the folder then using the `git init .` command will do the same thing.
+
+![[Pasted image 20240216114456.png]]
+
+
+## Verify Repository was Created
+
+To check it is created we use the `ls -la` command:
+
+![[Pasted image 20240216113831.png]]
+
+Notice the last line. The `d` at the start tells you it is a folder (directory), and its name is `.git`. It is a hidden folder.
+
+All tracking of changes are then stored in the `.git` folder. If you delete this folder, you delete the whole history of your project.

04-git-started.md

@@ -0,0 +1,123 @@
+## Global configuration changes
+
+Git, like any software has many things that can be changed. These area stored in a global configuration file, in a project only configuration file.
+
+Most of the configuration options are able to be set for both, but we show the global (for you as the user) changes you may want to make.
+
+### Git User Name and Email Address
+
+To change the username and email address being stored as part of the commit sequence, we use the following two commands:
+
+```bash
+git config --global user.name "YOUR NAME"
+git config --global user.email "YOUR EMAIL ADDRESS"
+```
+
+The `--global` indicates that the changes are stored for this and all future projects.
+
+![[Pasted image 20240216124422.png]]
+
+To see the global settings...
+```shell
+git config --list --global
+```
+
+![[Pasted image 20240216124543.png]]
+
+### Per Project Configuration
+
+These need to be repeated for any project that is not going to be listed under your 'global' config.
+
+Make sure you are in the project you wish to use project only configured settings.
+
+Then set your required configuration by using:
+
+```shell
+git config SETTING VALUE
+```
+
+For example, changing the "user" and "email" to be your TAFE details rather than using your personal email and name...
+
+Lets say your ID is `00000000` and email is `[email protected]` we could use:
+
+```bash
+git config user.name "00000000"
+git config user.email "[email protected]"
+```
+
+The `--global` indicates that the changes are stored for this and all future projects.
+
+![[Pasted image 20240216124422.png]]
+
+
+### Default "Branch" name to Main...
+
+To do this for ALL FUTURE projects we use:
+
+```bash
+git config --global init.defaultBranch main
+```
+### Change Current Project's Branch Name
+
+To change the current 'master branch' to be the 'main branch' we need to do the following *AFTER* a commit is completed:
+```bash
+git branch -m master main
+```
+
+![[Pasted image 20240216125018.png]]
+
+
+
+
+
+
+### Default Commit Message Editor
+
+It is possible to change the code editor for commit messages to something like Notepad.
+
+Below we change the editor to "nano" - a extremely small footprint terminal text editor on MacOS and Linux.
+
+```shell
+git config --global core.editor "nano"
+```
+
+To change it to Notepad we would use:
+
+```shell
+git config --global core.editor "notepad"
+```
+
+> **Important:** when using a GUI editor such as Notepad, you **MUST** **SAVE** and **CLOSE** the message, then (usually optionally) **QUIT** the application for the message to be transferred to the git command.
+
+Now when you enter `git commit` the Notepad editor will open. The command line will tell you it is waiting for the editor to close a file (`COMMIT_MESSAGE`).
+
+![[Pasted image 20240223102507.png]]
+
+When Notepad is opened, it will show a set of comments that tell you details about the added files as comments.
+
+![[Pasted image 20240223102034.png]]
+
+Now editing the commit message and adding the details that may be more than just a one liner is easy.
+
+You then enter the SHORT commit message and, as required, a blank line followed by more details about the changes that have been made to the project.
+
+For example:
+
+```text
+feat(readme): Add demo commit demo of external editor
+
+- Change config for default commit editor to Notepad
+- Add a single blank line to the ReadMe for demo purposes
+- Add ReadMe to staging
+- Run git commit
+- Demonstrate the long form of commit message
+- Save (`CTRL`+`S`) and close (`CTRL`+`F4`) the message
+- Optionally, quit the editor (`ALT`+`F4`)
+```
+
+
+
+> **Warning:** Tests have indicated that you will not be able to use 'VSCode' as the editor for messages. 
+> 
+> On execution the editor does not negotiate correctly with the command line and git aborts the commit.
+

05-global-settings.md

@@ -0,0 +1,19 @@
+## Creating a `ReadMe.md` for the project
+
+The Bash/git shell has the ability to create a empty file really easily. 
+
+For example an empty `ReadMe.md` file would be created using:
+
+```shell
+touch ReadMe.md
+```
+
+In the Windows Command Prompt we need to use:
+
+```shell
+copy nul > ReadMe.md
+```
+
+The `>` tells the command to write to a file with the name of the file after the `>`.
+
+If you used `>>` it would append the output of the command to the file named after the `>>`.