[PATCH app/xcursorgen v3] Update README for gitlab migration

[Alan Coopersmith]

On 11/13/18 04:57 PM, Alan Coopersmith wrote:
> On 11/13/18 05:41 AM, Julien Cristau wrote:
>> LGTM.  Thanks Alan!
> 
> Thanks to you, Peter, & Ray for reviews.   I merged this, and thought
> "Okay, time to cut a new release."  And then I found the mistake.
> 
> automake automatically includes a file named "README" in the tarball.
> It does not include a file named "README.md".
> 
> So, we seem to have two choices:
> 
> 1) Ship with README.md:
>      Just add "EXTRA_DIST = README.md" to Makefile.am in every component.
> .
> 2) Ship with README:
>     Follow our pattern with Changelog & INSTALL files and add a macro
>     to xorg-macros.m4 to define a makefile macro such as:
>      README_CMD = cp -f $(top_srcdir)/README.md $(top_srcdir)/README
>     and in Makefile.am in every component:
> 
> +README:
> +    $(README_CMD)
> +
> -dist-hook: ChangeLog INSTALL
> +dist-hook: ChangeLog INSTALL README
> 
> 
> Anyone have a preference?   Shipping README.md seems easier - will it cause
> problems for any distros or packagers?

3rd choice - this seems to work for me, shipping a file named README in the
tarball without any Makefile modifications:

% ln -s README.md README
% git add README
% git commit -m 'ln -s README.md README'

Is checking symlinks into git going to break Windows or any other platforms?

-- 
	-Alan Coopersmith-               alan.coopersmith at oracle.com
	 Oracle Solaris Engineering - https://blogs.oracle.com/alanc