Added note to README about LaTeX requirement

mitchelloharawild#29
niklasben · Jan 11, 2019 · 0c82bc2 · 0c82bc2
1 parent 31a489f
commit 0c82bc2
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -37,6 +37,14 @@ You can install the **development** version from
 devtools::install_github("ropenscilabs/vitae")
 ```
 
+This package requires LaTeX to be installed on your computer. If you're encountering issues, please check that LaTeX is installed. The [tinytex package](https://github.com/yihui/tinytex) makes it easy to setup LaTeX within R:
+
+```{r tinytex-installation, eval = FALSE}
+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://ropenscilabs.github.io/vitae/articles/extending.html) vignette).

diff --git a/README.md b/README.md
@@ -32,6 +32,16 @@ You can install the **development** version from
 devtools::install_github("ropenscilabs/vitae")
 ```
 
+This package requires LaTeX to be installed on your computer. If you’re
+encountering issues, please check that LaTeX is installed. The [tinytex
+package](https://github.com/yihui/tinytex) makes it easy to setup LaTeX
+within R:
+
+``` r
+install.packages('tinytex')
+tinytex::install_tinytex()
+```
+
 ## Getting started
 
 The *vitae* package currently supports 4 popular CV templates, and