Re: [WAS: Re: Review/sponsorship of osmalchemy package] md , rst, txt, html, ...

2016-09-28 Thread Guido van Steen
Hi Jerome,

I may not fully understand the issue, but why not keep *.md, *.rst, *.pod,
etc. the way they are?

The main advantage of *.md, *.rst, *.pod, etc. is their readability. Their
additional advantage is that they can easily be transferred into *.html or
many other formats, if desired.

A missing man page might make such a conversion necessary. In that case a
*.md, *.rst, *.pod, or a .whatever file could be converted into *.*roff,
which should be done during build process.

Standard conversion of *.md, *.rst, *.pod, etc. to *.txt is IMO a plain bad
idea, because *.md, *.rst, *.pod files are meant to be readable text files
anyway.

Best wishes,

Guido van Steen


[WAS: Re: Review/sponsorship of osmalchemy package] md , rst, txt, html, ...

2016-09-27 Thread Jerome BENOIT
Hello Forum,

On 27/09/16 23:41, Thomas Goirand wrote:
> debian/docs:
> 
> * It looks like the README.rst could be transformed into .html using
> sphinx. Could you do that? It'd look a lot nicer.


Some software comes with a README.md, README.rst, ...
which are the same version of a text but written in different format:
Must we pick up one ? If so, which one ? or may we transform one of them
in txt (or html) ?

Thanks,
Jerome