Commit 813dd4c5 authored by Iago Mosqueira's avatar Iago Mosqueira
Browse files

New README.md

parent 5f64c253
# wmrkdown
<!-- badges: start -->
<!-- badges: end -->
The goal of wmrkdown is to provide `rmarkdown` versions of various WMR document templates. Currently, a template exists for creating a WUR-style presentation using markdown (md) or R markdown (Rmd).
## Installation
You can install wmrkdown from [WUR git](https://git.wur.nl/mosqu003/wmrkdown) with:
``` r
devtools::install_git("https://git.wur.nl/mosqu003/wmrkdown")
```
Make sure the required dependencies are available in your system:
``` r
install.packages(c("rmarkdown", "knitr"))
```
## Example
To create a new presentation, called "example", you can call
``` r
library(wmrkdown)
draft("example.Rmd",
template="wur", package="wmrkdown")
```
A folder caled `example` will be created containing the following files:
- `example.Rmd`, the R markdown file for you to edit.
- `default.jpg`, the picture for the left handside of the front page.
- `front.jpg`, the picture for the right handside of the front page, taken from the WUR powerpoint template.
- `logo.png`, WUR's logo.
- `beamerthemewurnew.sty`, the LaTeX style file for WUR's presentation.
You are free to change the pictures, as long as you use the same names.
After working on the Rmd file, you can create the PDF output using
```r
render("example.Rmd")
```
......@@ -11,6 +11,6 @@ library(rmarkdown)
# CREATE an empty presentation from template
fn <- draft("myslides.Rmd", template="wur", package="wmrkdown", edit=FALSE)
fn <- draft("myslides.Rmd", template="wur", package="wmrkdown")
setwd("myslides") ## template creates a new subdir
render("myslides.Rmd")
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment