Readmexec

Readmexec grabs commands from your README and runs them.

The idea is to make README executable and verifiable since this is the only way to make sure it stays up to date. You can ensure that by using readmexec locally or on CI and verify that build instructions are still working.

Example

gem install readmexec

Create a directory and grab README from github

mkdir -p readmexec
curl https://raw.githubusercontent.com/wojtekmach/readmexec/master/README.md > readmexec/README.md

Run readmexec. By default it will just output commands it's going to execute:

cd readmexec
readmexec

Run readmexec -e to run commands instead of just printing them.