Skip to content

Commit 6d68c8a

Browse files
committed
Fixed typos in README (derived from HPC Training Book Chapter 1.6)
1 parent 0f6a6bb commit 6d68c8a

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,25 @@ To get setup:
2020
- Run:
2121

2222
```sh
23-
git clone <repo-link> # Clone to your machine
24-
cd <repo-name> # Enter clone's directory
25-
git remote add upstream <repo-link> # Create link to template called 'upstream'
26-
git remote set-url --push upstream DISABLE # Disable pushing to template
27-
git fetch upstream # Sync with 'upstream'
28-
git merge upstream/main --allow-unrelated-histories # Merge 'upstream' main branch with your main
23+
# Clone to your machine
24+
git clone <repo-link>
25+
26+
# Enter clone's directory
27+
cd <repo-name>
28+
29+
# Create link to template called 'upstream'
30+
git remote add upstream https://github.com/MonashDeepNeuron/HPC-Training-Challenges.git
31+
32+
# Disable pushing to template
33+
git remote set-url --push upstream DISABLE
34+
35+
# Sync with 'upstream'
36+
git fetch upstream
37+
38+
# Merge 'upstream' main branch with your main
39+
git merge upstream/main --allow-unrelated-histories
40+
41+
# Open repository in VSCode
2942
code .
3043
```
3144

@@ -64,7 +77,7 @@ When you want to attempt a challenge it is good practice to create a branch. Thi
6477
git branch <branch-name> # Create new branch
6578
git checkout <branch-name> # Checkout to the new branch
6679
# or
67-
git checkout -b <branch-name # Checkout to a new branch
80+
git checkout -b <branch-name> # Checkout to a new branch
6881
```
6982

7083
For your training. I would recommend creating a new branch for every challenge you attempt and merging them with the `main` (default) branch once you are done. This allows you to make modifications to each of your attempts independent of each other as well as make it easier to resync with the template repository should anything change at its base. it also allows you to get some meaningful practice with Git which is one of the most used developer tools in the world.

0 commit comments

Comments
 (0)