Branch: refs/heads/blead
  Home:   https://github.com/Perl/perl5
  Commit: 8975221916115baa0cf0fceb2f33c1abb6ae50b9
      
https://github.com/Perl/perl5/commit/8975221916115baa0cf0fceb2f33c1abb6ae50b9
  Author: Bram <[email protected]>
  Date:   2022-09-03 (Sat, 03 Sep 2022)

  Changed paths:
    A .github/README.md
    M t/porting/copyright.t

  Log Message:
  -----------
  Add a .github/README.md

This is based on the existing README and is an almost exact copy.
Some minor formatting changes to improve the rendering but the text
remains the same. This is done because not having a formatted README
is blocking some other changes.[^1]

t/porting/copyright.t was also adjusted to check the copyright in
.github/README.md

*Long term*: In the long term the contents of README and .github/README.md
will differ. Since these serve a different purpose:
- README: this is included with each release and for that it's more then
  good enough enough;
- .github/README.md: this is for people viewing the repository on GitHub
  and for that the current README is - in my opinion - not good enough.
  It should be much more informative (compare it with some other repos
  and that should be obvious, in #18965 there are some examples but
  many more exist).

[^1]: rendering platform specific READMEs as POD in GitHub.


Reply via email to