Creates skeleton README files with sections for
a high-level description of the package and its goals
R code to install from GitHub, if GitHub usage detected
a basic example
Rmd if you want a rich intermingling of code and output. Use
md for a
README.Rmd will be automatically added to
The resulting README is populated with default YAML frontmatter and R fenced
code blocks (
md) or chunks (
If you use
Rmd, you'll still need to render it regularly, to keep
devtools::build_readme() is handy for this. You
could also use GitHub Actions to re-render
README.Rmd every time you push.
An example workflow can be found in the
examples/ directory here:
1 2 3
Open the newly created file for editing? Happens in RStudio, if
applicable, or via
1 2 3 4 5
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.