Skip to content

Commit bcec270

Browse files
committed
small edits
1 parent dcc2543 commit bcec270

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

slides/05_publication.qmd

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,13 @@ author: Audrey T. Yeo
1919
## Setup of `pkgdown`
2020

2121
- `pkgdown` makes it quick and easy to build a website for your package
22-
- After installing `pkgdown`, run `usethis::use_pkgdown()`* to get started
22+
- After installing `pkgdown`, run `usethis::use_pkgdown()` to get started
2323
- Alternatively, run `usethis::use_pkgdown_github_pages()`
24-
- Adds (and writes) `pkgdown.yml`\*, `docs` folder, and "pkgdown" to `.Rbuildignore`\* and `docs` to `gitignore`\*. Also initialises empty branch `gh-pages` in chosen repo and activates GitHub Pages for repo.
25-
24+
- Adds (and writes) `pkgdown.yml`, `docs` folder, and "pkgdown" to `.Rbuildignore` and `docs` to `gitignore`. Also initialises empty branch `gh-pages` in chosen repo and activates GitHub Pages for repo [^1].
2625
- Main configuration happens in `_pkgdown.yml` file
2726
- Many customizations can be applied, but bulk of work during development is
2827
updating the `reference` section with names of `.Rd` files
29-
28+
[^1]: `usethis::use_pkgdown_github_pages()` performs these actions additionally to `usethis::use_pkgdown()`.
3029

3130
## Example `_pkgdown.yml` File
3231

@@ -294,9 +293,9 @@ c. any .Rd file
294293
::: columns
295294
::: {.column width="40%"}
296295
1. I am cloning / forking a repo that has an MIT Licence. Which license shall I use if I want to make modification and distribute my new package ?
297-
a. **MIT Licence**
298-
b. one of any copyleft Licences
299-
c. no licence assumes transfer of my rights from the original repo
296+
a. MIT Licence
297+
b. **any licence**
298+
c. no licence because that assumes transfer of my rights from the original repo's MIT Licence
300299
:::
301300

302301
::: {.column width="10%"}
@@ -315,7 +314,7 @@ c. any .Rd file
315314

316315
# Exercise
317316

318-
Use the your project from chapter 5 :
317+
Use your project from *chapter 2* :
319318

320319
- Run CRAN-like checks in RStudio:
321320
- Go to Tools -> Project Options -> Build Tools -> "Check package - R CMD check additional options" : -> type "--as-cran"

0 commit comments

Comments
 (0)