OOSD Coursework 1

The report is updated on every commit and is viewable here

Using Git

Getting The Repository Setup

1. Install Git
2. Open the folder you want this repository in
3. Right click and select Git Bash Here
4. Type git clone https://github.com/wopian/oo-systems-development.git

Committing Changes

1. Click the 3rd icon on the left in VS Code
2. Enter a commit message (e.g feat: added consumer use cases)
3. Click the tick icon

Pulling & Pushing Changes

1. Click the refresh icon in the bottom left (next to where it says master)
   • This first pulls all the commits from the repository
   • Then pushes your commits to it

Using LaTeX

1. Install MiKTeX
2. Run Update MiKTeX twice with default options
3. Install Visual Studio Code
4. Install the following VS Code extensions:
   • LaTeX Workshop (Compile and preview LaTeX report)
   • Spell Right (Spellchecker for VS Code)
   • EditorConfig for VS Code (Shared editor settings)

Previewing the Report

1. Open report/report.tex
2. Right click anywhere
3. Click Build LaTeX Project (Ctrl+Alt+B)
4. Click the red icon in top right to preview report (Ctrl+Alt+T)
5. Preview will auto-update on saving any .tex file