Skip to content

Commit 1f4861d

Browse files
committed
update some git
1 parent 7d8e9e0 commit 1f4861d

File tree

3 files changed

+29
-11
lines changed

3 files changed

+29
-11
lines changed

content/_toc.yml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,13 @@ parts:
7575
- file: 09-packages/python-packages
7676
- file: 09-packages/python-tools
7777

78+
- caption: Git and Github
79+
chapters:
80+
- file: git/version-control
81+
- file: git/git
82+
- file: git/github
83+
- file: git/pull-requests
84+
7885
- caption: Unit tests
7986
chapters:
8087
- file: 10-testing/testing
@@ -88,9 +95,3 @@ parts:
8895
- file: 12-extensions/extensions-overview
8996
- file: 12-extensions/extensions-example
9097

91-
- caption: Git and Github
92-
chapters:
93-
- file: git/version-control
94-
- file: git/git
95-
- file: git/github
96-
- file: git/pull-requests

content/git/git.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ git config --global core.editor "nano -w"
2929

3030
Replace `name` with your name and `email` with your email. This sets `nano`
3131
as our default editor, but you can choose something else that you are comfortable
32-
with (see https://swcarpentry.github.io/git-novice/02-setup/index.html#line-endings).
32+
with (see https://swcarpentry.github.io/git-novice/02-setup.html).
3333

3434
This information will be stored in a file called ``.gitconfig`` in your home directory.
3535

@@ -99,7 +99,7 @@ project.
9999

100100
```
101101
commit 2001a0e996110926a576dcb5fc13fc8022864d0b (HEAD -> main)
102-
Author: Michael Zingale <michael.zingake@stonybrook.edu>
102+
Author: Michael Zingale <michael.zingale@stonybrook.edu>
103103
Date: Sun Jan 30 13:11:24 2022 -0500
104104
105105
my first change
@@ -165,8 +165,7 @@ project.
165165
modified: README
166166
```
167167

168-
```{note}
169-
**What is add really doing?**
168+
```{admonition} What is `add` really doing?
170169

171170
Git has a concept call the *staging area*. When we ``add`` a
172171
file, git puts the changes into the staging area. We can add

content/git/version-control.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
11
# Version Control
22

3+
````{note}
4+
To follow along, you will need to install `git` on your computer.
5+
You can follow the instructions from the [Software Carpentry lessons](https://carpentries.github.io/workshop-template/install_instructions/#git). In particular, for:
6+
7+
* Windows: use [git for Windows](https://gitforwindows.org/)
8+
9+
* Mac: in a teminal, do:
10+
11+
```
12+
git --version
13+
```
14+
15+
If it is not already installed, it will prompt you for installation.
16+
17+
* Linux: it is probably already installed, but otherwise, use your
18+
package manager.
19+
````
20+
321
## Why use version control?
422

523
When we develop code, we are going to be making lots of changes over
@@ -13,7 +31,7 @@ time. And you will find yourself in the following situations:
1331
* *Your research group is all working on the same code* and you need to sync up with
1432
everyone's changes and make sure that no one breaks the code.
1533

16-
This is what version control does for us.
34+
This is what [version control](https://en.wikipedia.org/wiki/Version_control) does for us.
1735

1836

1937
```{note}

0 commit comments

Comments
 (0)