TLDR Dev · OPINIONS & ADVICE

HOW TO *ACTUALLY* TEST YOUR README

shkspr.mobi9 min read

Summary from the TLDR Dev newsletter

Devs should test their software's installation instructions on a fresh virtual machine. When doing so, they should document every step taken during the installation process, including installing dependencies, and then transferring that documented history to the README file to guarantee accuracy and completeness.