Added Bryan Jenks' tech talk video to README (and reorganised README …

…contents)
mitchelloharawild · Apr 23, 2021 · 104328b · 104328b
1 parent 714ae6d
commit 104328b
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 39 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -26,24 +26,7 @@ template_preview <- list.files(file.path("man", "figures"), pattern = "^preview"
                        full.names = TRUE)
 template_name <- stringr::str_match(basename(template_preview), "preview-(.+?)\\.png")[,2]
 ```
-The *vitae* package makes creating and maintaining a Résumé or CV with R Markdown simple. It provides a collection of LaTeX and HTML templates, with helpful functions to add content to the documents. There are currently `r length(template_name)` templates available in this package:
-
-```{r show-previews, echo = FALSE, results='asis'}
-preview_url <- sprintf("https://pkg.mitchelloharawild.com/vitae/reference/%s.html", template_name)
-preview_title <- sprintf("[**vitae::%s**](%s)", template_name, preview_url)
-preview_image <- sprintf("[![Preview of %s](%s){width=415px}](%s)", template_name, template_preview, preview_url)
-
-preview_row <- (seq_along(preview_title)+1)%/%2
-for(i in split(seq_along(preview_title), preview_row)) {
-  print(
-    knitr::kable(
-      tibble::new_tibble(setNames(as.list(preview_image[i]), preview_title[i]), nrow = 1),
-      escape = FALSE
-    )
-  )
-}
-```
-
+The *vitae* package makes creating and maintaining a Résumé or CV with R Markdown simple. It provides a collection of LaTeX and HTML templates, with helpful functions to add content to the documents. 
 
 ## Installation
 
@@ -68,10 +51,12 @@ install.packages('tinytex')
 tinytex::install_tinytex()
 ```
 
-
 ## Getting started
 
-The *vitae* package currently supports `r length(list.dirs("inst/rmarkdown/templates/", recursive = FALSE))` popular CV templates, and adding more is a relatively simple process (details in the [creating vitae templates](https://pkg.mitchelloharawild.com/vitae/articles/extending.html) vignette).
+The *vitae* package currently supports `r length(list.dirs("inst/rmarkdown/templates/", recursive = FALSE))` popular CV templates. You can see some previews of the available templates [below](#templates).
+
+If you prefer a guided introduction in video form, check out [Bryan Jenks](https://github.com/tallguyjenks)' [freeCodeCamp](https://github.com/freeCodeCamp/freeCodeCamp) [tech talk](https://youtu.be/cMlRAiQUdD8):
+[![](man/figures/freecodecamp.jpg)](https://youtu.be/cMlRAiQUdD8)
 
 Creating a new CV with `vitae` can be done using the RStudio R Markdown template selector:
 ![](man/figures/template_gui.png)
@@ -115,6 +100,27 @@ orcid_data %>%
 
 Additional examples of using this package can be found in the slides presented at [ozunconf2018](https://ozunconf18.ropensci.org/): [https://slides.mitchelloharawild.com/vitae/](https://slides.mitchelloharawild.com/vitae/)
 
+## Templates
+
+There are currently `r length(template_name)` templates available in this package:
+
+```{r show-previews, echo = FALSE, results='asis'}
+preview_url <- sprintf("https://pkg.mitchelloharawild.com/vitae/reference/%s.html", template_name)
+preview_title <- sprintf("[**vitae::%s**](%s)", template_name, preview_url)
+preview_image <- sprintf("[![Preview of %s](%s){width=415px}](%s)", template_name, template_preview, preview_url)
+
+preview_row <- (seq_along(preview_title)+1)%/%2
+for(i in split(seq_along(preview_title), preview_row)) {
+  print(
+    knitr::kable(
+      tibble::new_tibble(setNames(as.list(preview_image[i]), preview_title[i]), nrow = 1),
+      escape = FALSE
+    )
+  )
+}
+```
+Extending the package to add new templates is a somewhat simple process (details in the [creating vitae templates](https://pkg.mitchelloharawild.com/vitae/articles/extending.html) vignette).
+
 ## Examples of using vitae
 
 - [Mitchell O'Hara-Wild](https://github.com/mitchelloharawild/CV)

diff --git a/README.md b/README.md
@@ -17,20 +17,7 @@ maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lif
 
 The *vitae* package makes creating and maintaining a Résumé or CV with R
 Markdown simple. It provides a collection of LaTeX and HTML templates,
-with helpful functions to add content to the documents. There are
-currently 6 templates available in this package:
-
-| [**vitae::awesomecv**](https://pkg.mitchelloharawild.com/vitae/reference/awesomecv.html)                                                                   | [**vitae::hyndman**](https://pkg.mitchelloharawild.com/vitae/reference/hyndman.html)                                                                 |
-|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|
-| [<img src="man/figures/preview-awesomecv.png" width="415" alt="Preview of awesomecv" />](https://pkg.mitchelloharawild.com/vitae/reference/awesomecv.html) | [<img src="man/figures/preview-hyndman.png" width="415" alt="Preview of hyndman" />](https://pkg.mitchelloharawild.com/vitae/reference/hyndman.html) |
-
-| [**vitae::latexcv**](https://pkg.mitchelloharawild.com/vitae/reference/latexcv.html)                                                                 | [**vitae::markdowncv**](https://pkg.mitchelloharawild.com/vitae/reference/markdowncv.html)                                                                    |
-|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [<img src="man/figures/preview-latexcv.png" width="415" alt="Preview of latexcv" />](https://pkg.mitchelloharawild.com/vitae/reference/latexcv.html) | [<img src="man/figures/preview-markdowncv.png" width="415" alt="Preview of markdowncv" />](https://pkg.mitchelloharawild.com/vitae/reference/markdowncv.html) |
-
-| [**vitae::moderncv**](https://pkg.mitchelloharawild.com/vitae/reference/moderncv.html)                                                                  | [**vitae::twentyseconds**](https://pkg.mitchelloharawild.com/vitae/reference/twentyseconds.html)                                                                       |
-|:--------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [<img src="man/figures/preview-moderncv.png" width="415" alt="Preview of moderncv" />](https://pkg.mitchelloharawild.com/vitae/reference/moderncv.html) | [<img src="man/figures/preview-twentyseconds.png" width="415" alt="Preview of twentyseconds" />](https://pkg.mitchelloharawild.com/vitae/reference/twentyseconds.html) |
+with helpful functions to add content to the documents.
 
 ## Installation
 
@@ -60,11 +47,14 @@ tinytex::install_tinytex()
 
 ## Getting started
 
-The *vitae* package currently supports 6 popular CV templates, and
-adding more is a relatively simple process (details in the [creating
-vitae
-templates](https://pkg.mitchelloharawild.com/vitae/articles/extending.html)
-vignette).
+The *vitae* package currently supports 6 popular CV templates. You can
+see some previews of the available templates [below](#templates).
+
+If you prefer a guided introduction in video form, check out [Bryan
+Jenks](https://github.com/tallguyjenks)’
+[freeCodeCamp](https://github.com/freeCodeCamp/freeCodeCamp) [tech
+talk](https://youtu.be/cMlRAiQUdD8):
+[![](man/figures/freecodecamp.jpg)](https://youtu.be/cMlRAiQUdD8)
 
 Creating a new CV with `vitae` can be done using the RStudio R Markdown
 template selector: ![](man/figures/template_gui.png)
@@ -131,6 +121,27 @@ Additional examples of using this package can be found in the slides
 presented at [ozunconf2018](https://ozunconf18.ropensci.org/):
 <https://slides.mitchelloharawild.com/vitae/>
 
+## Templates
+
+There are currently 6 templates available in this package:
+
+| [**vitae::awesomecv**](https://pkg.mitchelloharawild.com/vitae/reference/awesomecv.html)                                                                   | [**vitae::hyndman**](https://pkg.mitchelloharawild.com/vitae/reference/hyndman.html)                                                                 |
+|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|
+| [<img src="man/figures/preview-awesomecv.png" width="415" alt="Preview of awesomecv" />](https://pkg.mitchelloharawild.com/vitae/reference/awesomecv.html) | [<img src="man/figures/preview-hyndman.png" width="415" alt="Preview of hyndman" />](https://pkg.mitchelloharawild.com/vitae/reference/hyndman.html) |
+
+| [**vitae::latexcv**](https://pkg.mitchelloharawild.com/vitae/reference/latexcv.html)                                                                 | [**vitae::markdowncv**](https://pkg.mitchelloharawild.com/vitae/reference/markdowncv.html)                                                                    |
+|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [<img src="man/figures/preview-latexcv.png" width="415" alt="Preview of latexcv" />](https://pkg.mitchelloharawild.com/vitae/reference/latexcv.html) | [<img src="man/figures/preview-markdowncv.png" width="415" alt="Preview of markdowncv" />](https://pkg.mitchelloharawild.com/vitae/reference/markdowncv.html) |
+
+| [**vitae::moderncv**](https://pkg.mitchelloharawild.com/vitae/reference/moderncv.html)                                                                  | [**vitae::twentyseconds**](https://pkg.mitchelloharawild.com/vitae/reference/twentyseconds.html)                                                                       |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [<img src="man/figures/preview-moderncv.png" width="415" alt="Preview of moderncv" />](https://pkg.mitchelloharawild.com/vitae/reference/moderncv.html) | [<img src="man/figures/preview-twentyseconds.png" width="415" alt="Preview of twentyseconds" />](https://pkg.mitchelloharawild.com/vitae/reference/twentyseconds.html) |
+
+Extending the package to add new templates is a somewhat simple process
+(details in the [creating vitae
+templates](https://pkg.mitchelloharawild.com/vitae/articles/extending.html)
+vignette).
+
 ## Examples of using vitae
 
 -   [Mitchell O’Hara-Wild](https://github.com/mitchelloharawild/CV)

diff --git a/man/figures/freecodecamp.jpg b/man/figures/freecodecamp.jpg