Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Simple README file generation. #234

mralexgray opened this Issue Aug 3, 2012 · 3 comments


None yet
2 participants

I would guess that this is easily possible with the templates or whatnot.. but they are a generally pretty advanced feature.. It would be nice if you could just generate a simple project readme that was somehow based on either a comment block or some part of the existing documentation set, etc.

@tomaz tomaz closed this Aug 3, 2012

@tomaz tomaz reopened this Aug 3, 2012


tomaz commented Aug 3, 2012

Interesting idea, will keep it in "ideas pool"

I really want to implement this.. Can you give me a hint.. and I'll do it, and push it... or at least try?


tomaz commented Oct 13, 2013

First of all, everything appledoc parses gets stored to GBStore. From there on, post-processing phase is invoked which parses comments for cross refs etc and finally the execution proceeds to GBGenerator which generates everything (by delegating work to concrete GBOutputGenerator subclasses)

To start, I'd created a new output generator which will create readme file - take a look into existing ones to see which hooks are there for overriding. In there go through all data in store that is passed to your subclass and prepare readme file. The simplest way would be to just append text to a NSMutableString, but you can also use template much the same way html is handled. Last but not least, create new cmd line argument that will enable or disable readme file generation.

Hope this gives you the push you need to get started!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment