Create About.md

Author: 3mmaRand

package-dev-modules/slides/04-package-documentation/About.md

@@ -0,0 +1,23 @@
+# Package documentation
+
+This workshop shows you how to document your package.
+
+## Learning Objectives
+
+At the end of this module the successful learner will be able to:
+-  recognise the different levels of package documentation: Metadata, Object documentation, Vignettes and pkgdown sites
+-  explain, create and populate a DESCRIPTION file
+-  know how to add package dependencies with usethis::use_package() and the difference between Imports and Suggests
+-  explain the components of a LICENSE file
+-  add object documentation using roxygen2 and devtools::document()
+-  explain what a vignette is and create one with usethis::use_vignette()
+-  know how pkgdown sites can be created
+
+
+## Prerequisites
+You need to have:
+-  "[Packages in a nutshell](http://bit.ly/pkg-dev-1)" or equivalent experience
+-  "[Setting up your system](http://bit.ly/pkg-dev-2)" or equivalent experience
+-  "[Your first package]"(http://bit.ly/pkg-dev-3) or equivalent experience
+-  the packages devtools, roxygen2, testthat and knitr installed
+-  R build toolchain: Rtools(windows) or XCode (mac) or r-base-dev