Project specific readme.Rmd

Fixes #85

Author: hadley

R/helpers.R

@@ -44,6 +44,14 @@ is_package <- function(base_path = proj_get()) {
   file.exists(file.path(base_path, "DESCRIPTION"))
 }
 
+project_data <- function(base_path = proj_get()) {
+  if (is_package(base_path)) {
+    package_data(base_path)
+  } else {
+    list(Project = basename(base_path))
+  }
+}
+
 package_data <- function(base_path = proj_get()) {
   desc <- desc::description$new(base_path)
 

R/readme.R

@@ -21,11 +21,11 @@
 use_readme_rmd <- function(open = TRUE) {
   check_installed("rmarkdown")
 
-  data <- package_data()
+  data <- project_data()
   data$Rmd <- TRUE
 
   use_template(
-    "omni-README",
+    if (is_package()) "omni-README" else "project-README.Rmd",
     "README.Rmd",
     data = data,
     ignore = TRUE,

inst/templates/project-README.Rmd

@@ -0,0 +1,30 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r setup, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+# {{{ Project }}}
+
+The goal of {{{ Project }}} is to ...
+
+What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:
+
+```{r cars}
+summary(cars)
+```
+
+You can also embed plots, for example:
+
+```{r pressure, echo = FALSE}
+plot(pressure)
+```
+
+In that case, don't forget to commit and push the resulting figure files, so they display on GitHub!