<div dir="ltr"><div>Hi everyone,</div><div><br></div><div>I have ported garcon's README to markdown (<a href="https://gitlab.xfce.org/xfce/garcon">https://gitlab.xfce.org/xfce/garcon</a>) to show how this could be done with the features of markdown for components that contain a README that is based on the template structure (What is it, Installation, Debugging support, How to report bugs).</div><div><br></div><div>Cheers</div><div>Simon</div><div><br></div><div>PS: Please ignore the failed pipeline for now. The "make distcheck" step runs fine locally with automake 1.16, but in our container we currently use 1.15. Autohell...<br></div><div><br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, May 12, 2020 at 11:27 PM Romain Bouvier <<a href="mailto:skunnyk@alteroot.org">skunnyk@alteroot.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hello,<br>
<br>
Now that we have switched to gitlab, we want to have nice README in our projects, as they are more visibles ! :)<br>
Gitlab support markdown, and we need to rename README to README.md to use it. See this beautiful README: <a href="https://gitlab.xfce.org/xfce/xfce4-dev-tools/-/blob/master/README.md" rel="noreferrer" target="_blank">https://gitlab.xfce.org/xfce/xfce4-dev-tools/-/blob/master/README.md</a><br>
<br>
automake default to "gnu" behavior, which requires a file named "README": <a href="https://autotools.io/automake/options.html" rel="noreferrer" target="_blank">https://autotools.io/automake/options.html</a><br>
<br>
I propose to switch to "foreign" behavior, which is the recommended way, and don't seems to break anything (lots of project use foreign mode).<br>
<br>
You can take a look at this commit <a href="https://gitlab.xfce.org/xfce/xfce4-dev-tools/-/commit/fa58240b6b0070a6a7e446fa7bd6034eac452542" rel="noreferrer" target="_blank">https://gitlab.xfce.org/xfce/xfce4-dev-tools/-/commit/fa58240b6b0070a6a7e446fa7bd6034eac452542</a> on xfce4-dev-tools if you rename your README and want to fix your build (add foreign in AM_INIT_AUTOMAKE, and add README.md to dist tarball).<br>
<br>
<br>
Romain,<br>
_______________________________________________<br>
Xfce4-dev mailing list<br>
<a href="mailto:Xfce4-dev@xfce.org" target="_blank">Xfce4-dev@xfce.org</a><br>
<a href="https://mail.xfce.org/mailman/listinfo/xfce4-dev" rel="noreferrer" target="_blank">https://mail.xfce.org/mailman/listinfo/xfce4-dev</a></blockquote></div>