From 59f3bce161ea6ff50585515a316c9340d0c1555d Mon Sep 17 00:00:00 2001 From: Jan Suchotzki Date: Wed, 25 Mar 2015 13:58:08 +0100 Subject: [PATCH] Add description how to use markdownfmt.sh --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index faa14450..9d80ec6d 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ All Markdown files here are run through [tianon's fork of `markdownfmt`](https:/ Optionally: (we run this periodically, especially before pushing updated descriptions) - run `./update.sh myimage` to generate `myimage/README.md` +- run `./markdownfmt.sh -l myimage` to verify whether format of your markdown files is compliant to markdownfmt. In case you see any file names, markdownfmt detected some issues, which might result in a failed build during continuous integration. # What are all these files?