search

rtCamp / wp-plugin-bootstrap

A skeleton wordpress plugin to bootstrap & standardize your development
http://rtcamp.com/
9 stars 7 forks source link

readme.txt to readme.md parsing #2

Closed rahul286 closed 12 years ago

rahul286 commented 12 years ago

github friendly readme.md should be generated using readme.txt

rahul286 commented 12 years ago

See https://github.com/rtCamp/wp-plugin-bootstrap/issues/3

While creating readme.md for github, parse /img/assets/ dir to show banner/screenshots on github as well.

rahul286 commented 12 years ago

Please check - https://github.com/bungeshea/WP-Readme-Converter/blob/master/includes/converter.php

As you can see there is very little difference between wordpress readme.txt and github readme.md, we can use some sed commands inside deploy.sh only...

Or if we can create a pre-commit or some hook handler where everytime reademe.txt is changed, hook will update readme.md

rahul286 commented 12 years ago

This is another link you can refer to - https://github.com/benbalter/WP-Readme-to-Github-Markdown/blob/master/index.php

rahul286 commented 12 years ago

We will need to some work to handle images. See - http://stackoverflow.com/questions/11915826/github-image-not-showing-up-in-readme-md

MiteshShah commented 12 years ago

Fixed in https://github.com/rtCamp/wp-plugin-bootstrap/commit/63800537c538aa31414eb431096f2cb13dcb095d