devtools (version 1.13.3)

use_readme_rmd: Create README files.

Description

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

Use Rmd if you want a rich intermingling of code and data. Use md for a basic README. README.Rmd will be automatically added to .Rbuildignore. The resulting README is populated with default YAML frontmatter and R fenced code blocks (md) or chunks (Rmd).

Usage

use_readme_rmd(pkg = ".")
use_readme_md(pkg = ".")

Arguments

pkg

package description, can be path or package name. See as.package for more information

See Also

Other infrastructure: infrastructure, use_build_ignore, use_data_raw, use_data, use_news_md, use_package

Examples

# NOT RUN {
use_readme_rmd()
use_readme_md()
# }