R: Create README files

use_readme_rmd {usethis} | R Documentation

## 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(open = interactive())

    use_readme_md(open = interactive())

### Arguments

`open` | Open the newly created file for editing? Happens in RStudio, if applicable, or via `utils::file.edit()` otherwise.

### See Also

The important files section of R Packages.

### Examples

    ## Not run:
    use_readme_rmd()
    use_readme_md()

    ## End(Not run)

[Package usethis version 1.4.0 Index]