Provide quick start instructions.

mkcor · Dec 13, 2016 · ca13494 · ca13494
1 parent 2042749
commit ca13494
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,3 +3,16 @@
 An attempt at reproducing assessment reports in R. The general context is that
 of assessing the efficacy of educational programs, such as the Carpentry
 workshops.
+
+## Quick start
+
+Make sure you have
+[devtools](https://cran.r-project.org/web/packages/devtools/index.html)
+installed. In the R console (of RStudio), run
+
+    > devtools::install_github("mkcor/assmtrepr", build_vignettes = TRUE)
+    > browseVignettes("assmtrepr")
+
+## Inspiration
+
+http://rmflight.github.io/posts/2014/07/vignetteAnalysis.html