use_readme_rmd {devtools} | R Documentation |
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
).
use_readme_rmd(pkg = ".") use_readme_md(pkg = ".")
pkg |
package description, can be path or package name. See
|
Other infrastructure: infrastructure
,
use_build_ignore
,
use_data_raw
, use_data
,
use_news_md
, use_package
## Not run: use_readme_rmd() use_readme_md() ## End(Not run)