EVOLUTION-MANAGER
Edit File: use_readme_rmd.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Create README files</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body> <table width="100%" summary="page for use_readme_rmd {usethis}"><tr><td>use_readme_rmd {usethis}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>Create README files</h2> <h3>Description</h3> <p>Creates skeleton README files with possible stubs for </p> <ul> <li><p> a high-level description of the project/package and its goals </p> </li> <li><p> R code to install from GitHub, if GitHub usage detected </p> </li> <li><p> a basic example </p> </li></ul> <p>Use <code>Rmd</code> if you want a rich intermingling of code and output. Use <code>md</code> for a basic README. <code>README.Rmd</code> will be automatically added to <code>.Rbuildignore</code>. The resulting README is populated with default YAML frontmatter and R fenced code blocks (<code>md</code>) or chunks (<code>Rmd</code>). </p> <p>If you use <code>Rmd</code>, you'll still need to render it regularly, to keep <code>README.md</code> up-to-date. <code>devtools::build_readme()</code> is handy for this. You could also use GitHub Actions to re-render <code>README.Rmd</code> every time you push. An example workflow can be found in the <code style="white-space: pre;">examples/</code> directory here: <a href="https://github.com/r-lib/actions/">https://github.com/r-lib/actions/</a>. </p> <p>If the current project is a Git repo, then <code>use_readme_rmd()</code> automatically configures a pre-commit hook that helps keep <code>README.Rmd</code> and <code>README.md</code>, synchronized. The hook creates friction if you try to commit when <code>README.Rmd</code> has been edited more recently than <code>README.md</code>. If this hook causes more problems than it solves for you, it is implemented in <code>.git/hooks/pre-commit</code>, which you can modify or even delete. </p> <h3>Usage</h3> <pre> use_readme_rmd(open = rlang::is_interactive()) use_readme_md(open = rlang::is_interactive()) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>open</code></td> <td> <p>Open the newly created file for editing? Happens in RStudio, if applicable, or via <code><a href="../../utils/html/file.edit.html">utils::file.edit()</a></code> otherwise.</p> </td></tr> </table> <h3>See Also</h3> <p>The <a href="https://r-pkgs.org/release.html#important-files">important files section</a> of <a href="https://r-pkgs.org">R Packages</a>. </p> <h3>Examples</h3> <pre> ## Not run: use_readme_rmd() use_readme_md() ## End(Not run) </pre> <hr /><div style="text-align: center;">[Package <em>usethis</em> version 2.1.6 <a href="00Index.html">Index</a>]</div> </body></html>