Hello, On Mon 18 Nov 2024 at 11:01pm -08, Otto Kekäläinen wrote:
> Package: debian-policy > Found: 4.7.0.1 > > Currently > https://www.debian.org/doc/debian-policy/ch-source.html#source-package-handling-debian-readme-source > talks about `README.source`. > > I suggest we would allow this file to alternatively be in Markdown > format, and spell the filename as `README.source(.md)`. > > The suffix is relevant as many tools recognize the file as Markdown > based on the suffix and will only render it correctly with the suffix. > I am proposing Markdown specifically as it has become an industry > standard for ASCII markup and use on README.md files is very common. To be clear, it is definitely already allowed to be in markdown format. So what we would be adding would simply be an alternative file name. As README.source is primarily for human consumption, it seems like this wouldn't cause too much breakage. On the other hand, is there much benefit? People used to typing 'less debian/README.source' would need to retrain their fingers. You can already add Vim and Emacs annotations to specify that the file should have Markdown syntax highlighting, within the file. -- Sean Whitton
