Switch to 'foreign' behavior for automake invokation

Simon Steinbeiss simon at xfce.org
Wed May 13 00:40:12 CEST 2020


Hi everyone,

I have ported garcon's README to markdown (
https://gitlab.xfce.org/xfce/garcon) 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).

Cheers
Simon

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...


On Tue, May 12, 2020 at 11:27 PM Romain Bouvier <skunnyk at alteroot.org>
wrote:

> Hello,
>
> Now that we have switched to gitlab, we want to have nice README in our
> projects, as they are more visibles ! :)
> Gitlab support markdown, and we need to rename README to README.md to use
> it. See this beautiful README:
> https://gitlab.xfce.org/xfce/xfce4-dev-tools/-/blob/master/README.md
>
> automake default to "gnu" behavior, which requires a file named "README":
> https://autotools.io/automake/options.html
>
> 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).
>
> You can take a look at this commit
> https://gitlab.xfce.org/xfce/xfce4-dev-tools/-/commit/fa58240b6b0070a6a7e446fa7bd6034eac452542
> 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).
>
>
> Romain,
> _______________________________________________
> Xfce4-dev mailing list
> Xfce4-dev at xfce.org
> https://mail.xfce.org/mailman/listinfo/xfce4-dev
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.xfce.org/pipermail/xfce4-dev/attachments/20200513/c07a0ef1/attachment-0001.html>


More information about the Xfce4-dev mailing list