This is an old revision of the document!

mkreadmes is a tool I wrote in C to speed up building the README.html files for the Ports Collection. It is now available in ports as ports-mgmt/mkreadmes.

The program builds the README.html files orders of magnitude times faster than the standard “make readmes”, typically clocking in at under 30 seconds (or even less) for a rebuild of the files for the entire ports tree. A number of command line options are provided to make this as flexible and useful a tool as possible. Perhaps it may even eventually become part of the standard ports management tools set someday.

The latest, “finalized” version is now in the ports tree (version 1.2).

Please feel free to ask questions, make comments/suggestions.

– Conrad J. Sabatier conrads@cox.net