18.2 README.md

  • A README file is targetted towards a new user who is wondering whether they want to use your package
  • a README file is important for CRAN, pkgdown sites and GitHub
  • They go way back to the early days of computers. Here’s an example from 1974
  • In essence a README file tells someone who has come across your package:
    • a high level description of the package
    • a couple of simple examples
    • installation instructions
    • an overview of the main components of a package
  • example of the readme for dplyr