Comments on: Formatted READMEs http://alexking.org/blog/2007/01/03/formatted-readmes Alex King's blog - software, photography, sports, etc. Wed, 08 Oct 2008 04:04:36 +0000 http://wordpress.org/?v=2.2.3 By: Neha http://alexking.org/blog/2007/01/03/formatted-readmes#comment-53838 Neha Fri, 05 Jan 2007 07:53:55 +0000 http://alexking.org/blog/2007/01/03/formatted-readmes#comment-53838 Hey Alex King, Great help for us, thanx. Hey Alex King,

Great help for us, thanx.

]]> By: Alex http://alexking.org/blog/2007/01/03/formatted-readmes#comment-53828 Alex Thu, 04 Jan 2007 03:45:50 +0000 http://alexking.org/blog/2007/01/03/formatted-readmes#comment-53828 It works something like this: 1. pull the README from svn.wp-plugins.org/plugin/trunk 2. get the latest stable tag 3. pull the README from the latest stable tag 4. format and output I implemented this as a theme page rather than a plugin. Since my theme doesn't work like a "normal" theme, it's pretty much useless to anyone else. According to Mark Jaquith, who has made the official README validator (which also formats) code available here: http://svn.flatearth.org/svn/automattic-readme/ I am at least the 5th person to write code for this; following Matt, Mike Adams (whose version was adapted by Mark) and Owen Winkler. Unfortunately, I gave up and wrote my own mere days before the official validator was available (I wasn't even smart enough use a real markdown script). Oh well. :) It works something like this:

1. pull the README from svn.wp-plugins.org/plugin/trunk
2. get the latest stable tag
3. pull the README from the latest stable tag
4. format and output

I implemented this as a theme page rather than a plugin. Since my theme doesn’t work like a “normal” theme, it’s pretty much useless to anyone else.

According to Mark Jaquith, who has made the official README validator (which also formats) code available here:

http://svn.flatearth[...]ttic-readme/

I am at least the 5th person to write code for this; following Matt, Mike Adams (whose version was adapted by Mark) and Owen Winkler. Unfortunately, I gave up and wrote my own mere days before the official validator was available (I wasn’t even smart enough use a real markdown script). Oh well. :)

]]> By: Ajay http://alexking.org/blog/2007/01/03/formatted-readmes#comment-53827 Ajay Thu, 04 Jan 2007 03:27:26 +0000 http://alexking.org/blog/2007/01/03/formatted-readmes#comment-53827 Hi Alex, Would be great to know how you do this? Any tips/tutorials ? Hi Alex,

Would be great to know how you do this? Any tips/tutorials ?

]]> By: Dean http://alexking.org/blog/2007/01/03/formatted-readmes#comment-53825 Dean Thu, 04 Jan 2007 02:11:09 +0000 http://alexking.org/blog/2007/01/03/formatted-readmes#comment-53825 Cool. Is it pulling information straight from a text file and then formatting it? Or is it stored elsewhere? Cool. Is it pulling information straight from a text file and then formatting it? Or is it stored elsewhere?

]]>