Bläddra i källkod

Add description how to use markdownfmt.sh

Jan Suchotzki 10 år sedan
förälder
incheckning
59f3bce161
1 ändrade filer med 1 tillägg och 0 borttagningar
  1. 1 0
      README.md

+ 1 - 0
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?