Skip to content

Commit a95ddf0

Browse files
committed
docs: add links to Git resources
1 parent 83c717c commit a95ddf0

File tree

2 files changed

+35
-7
lines changed

2 files changed

+35
-7
lines changed

README.Rmd

+15-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ pak::pak("maelle/saperlipopette")
3333
You'll also need
3434

3535
- a [Git installation](https://happygitwithr.com/install-git), but if you made it here you probably already use Git at least a bit.
36-
- basic Git knowledge, in particular being able to examine the Git history, be it with [git log](https://git-scm.com/book/en/v2/Git-Basics-Viewing-the-Commit-History) or a tool in your IDE.
36+
- [basic Git knowledge](#recommended-resources-about-git), in particular being able to examine the Git history, be it with [git log](https://git-scm.com/book/en/v2/Git-Basics-Viewing-the-Commit-History) or a tool in your IDE.
3737
- a directory where to store the exercises folder. In all examples we use a temporary directory but if you prefer, you could use a dedicated "scratch directory".
3838

3939
## Why this name?
@@ -90,3 +90,17 @@ parent_path2 <- withr::local_tempdir()
9090
path2 <- exo_one_small_change(parent_path2)
9191
gert::git_log(repo = path2)
9292
```
93+
94+
95+
96+
### Recommended resources about Git
97+
98+
For beginners:
99+
100+
- [Happy Git with R](https://happygitwithr.com/)
101+
- [Learn Git branching](https://learngitbranching.js.org/)
102+
103+
For users less new to Git:
104+
105+
- [Git in Practice by Mike McQuaid](https://masalmon.eu/2023/11/01/reading-notes-git-in-practice/)
106+
- [Pro Git by Scott Chacon](https://masalmon.eu/2024/01/19/pro-git-scott-chacon-reading-notes/)

README.md

+20-6
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ You’ll also need
2323

2424
- a [Git installation](https://happygitwithr.com/install-git), but if
2525
you made it here you probably already use Git at least a bit.
26-
- basic Git knowledge, in particular being able to examine the Git
27-
history, be it with [git
26+
- [basic Git knowledge](#recommended-resources-about-git), in particular
27+
being able to examine the Git history, be it with [git
2828
log](https://git-scm.com/book/en/v2/Git-Basics-Viewing-the-Commit-History)
2929
or a tool in your IDE.
3030
- a directory where to store the exercises folder. In all examples we
@@ -47,10 +47,10 @@ This is a basic example which shows you how to solve a common problem:
4747
library("saperlipopette")
4848
parent_path <- withr::local_tempdir()
4949
path <- exo_one_small_change(parent_path)
50-
#> ℹ Follow along in /tmp/RtmpqqBEgT/file134996abeef9f/one-small-change!
50+
#> ℹ Follow along in /tmp/RtmpsiMrDj/file3e4f6663be0d/one-small-change!
5151
# what's in path
5252
fs::dir_tree(path)
53-
#> /tmp/RtmpqqBEgT/file134996abeef9f/one-small-change
53+
#> /tmp/RtmpsiMrDj/file3e4f6663be0d/one-small-change
5454
#> ├── R
5555
#> └── bla
5656
# with Git in a command line: git log
@@ -102,7 +102,7 @@ building documentation.
102102
``` r
103103
parent_path <- withr::local_tempdir()
104104
path <- exo_one_small_change(parent_path)
105-
#> ℹ Follow along in /tmp/RtmpqqBEgT/file134993f2829c5/one-small-change!
105+
#> ℹ Follow along in /tmp/RtmpsiMrDj/file3e4f474cb413/one-small-change!
106106
gert::git_log(repo = path)
107107
#> # A tibble: 2 × 6
108108
#> commit author time files merge message
@@ -111,11 +111,25 @@ gert::git_log(repo = path)
111111
#> 2 e227ecc55e421f70b6e30602e6a2ee… Jane … 2023-12-15 16:25:00 2 FALSE "First…
112112
parent_path2 <- withr::local_tempdir()
113113
path2 <- exo_one_small_change(parent_path2)
114-
#> ℹ Follow along in /tmp/RtmpqqBEgT/file134997abdb717/one-small-change!
114+
#> ℹ Follow along in /tmp/RtmpsiMrDj/file3e4f65cbaffc/one-small-change!
115115
gert::git_log(repo = path2)
116116
#> # A tibble: 2 × 6
117117
#> commit author time files merge message
118118
#> * <chr> <chr> <dttm> <int> <lgl> <chr>
119119
#> 1 2ff0d31f566e68ae0ee94b6028a3fa… Jane … 2023-12-15 16:25:00 1 FALSE "feat:…
120120
#> 2 e227ecc55e421f70b6e30602e6a2ee… Jane … 2023-12-15 16:25:00 2 FALSE "First…
121121
```
122+
123+
### Recommended resources about Git
124+
125+
For beginners:
126+
127+
- [Happy Git with R](https://happygitwithr.com/)
128+
- [Learn Git branching](https://learngitbranching.js.org/)
129+
130+
For users less new to Git:
131+
132+
- [Git in Practice by Mike
133+
McQuaid](https://masalmon.eu/2023/11/01/reading-notes-git-in-practice/)
134+
- [Pro Git by Scott
135+
Chacon](https://masalmon.eu/2024/01/19/pro-git-scott-chacon-reading-notes/)

0 commit comments

Comments
 (0)