[tex-live] Format of README file for a package

jfbu jfbu at free.fr
Sat Oct 4 14:12:09 CEST 2014

> That's true. But you can use a makefile for renaming, dedtxing and producing the documentation. And there can be other targets like git and ctan, e.g.:http://mirrors.ctan.org/macros/latex/contrib/getmap/makefile

thanks Josef for this link. 

So far I was easing up my workflow with shell scripts, but I knew at some point I should rather provide a Makefile, and having a model for one will help a lot.

>> [snip]
>> Indeed I already had experimented with producing README.pdf using Pandoc
>> from README.md and it's fine.

as I prefer the dvipdfmx route, I increased my Pandoc literacy through the writing of a suitable small latex template with a dvipdfmx option to pass to packages which need it. 

> Could also be a make target. You write it once and it's a no-brainer for the rest of your life! ;-)
> Josef

sure, if there is some life ;-) because after getting started with Markdown and Pandoc only a few days ago, I wonder looking back if it is the software which ends up being more alive than myself... (especially though as additionally someone tried this week to entice me to play with multiple cursors in Emacs: http://emacsrocks.com/e13.html )

anyway, it is fun.


More information about the tex-live mailing list