[Buildroot] [PATCH 2/4 v2] tools: move test-pkg out of support/scripts
Yann E. MORIN
yann.morin.1998 at free.fr
Thu Jun 22 19:20:53 UTC 2017
Arnout, Thomas, All,
On 2017-06-22 10:30 +0200, Arnout Vandecappelle spake thusly:
> On 22-06-17 10:13, Thomas Petazzoni wrote:
> > Hello,
> >
> > On Thu, 22 Jun 2017 09:57:36 +0200, Arnout Vandecappelle wrote:
> >
> >>> No strong opinion on whether such a move is desirable, but at the very
> >>> list I believe we should not add this 00-README.txt file. Nowhere else
> >>> in the tree we have files named like this, and I don't think we should
> >>> start adding these.
> >>
> >> Well, we have readme.txt in boards/, we have a README at the top level, we have
> >> a README generated by legal-info, we have a readme.txt in checkpackagelib... We
> >> indeed don't have a 00-README.txt though. IMO all of these files should be
> >> called README.md (or readme.md) so they are nicely formatted when viewed online.
> >>
> >> For this particular instance, I do like having some kind of README there. We
> >> need an overview of the existing tools somewhere, and I think a README file is a
> >> more appropriate place than the manual because it's easier to keep consistent.
> >> From the manual you can point to the directory.
> >
> > ACK, but then, named "readme.txt", to match what we're doing elsewhere:
> >
> > $ find . -name 'readme.txt' | wc -l
> > 99
OK, I'll re-instate the readme, and will change its name to readme.txt.
> Well, the point I tried to make in the paragraph above is that readme.txt is
> not a great name, readme.md would be better so it gets nicely formatted when
> viewed online on github, gitlab, etc and also in some editors. README.md is even
> better because then it is sorted first - which for the tools directory is very
> relevant IMO.
>
> Note that 96 of those 99 readmes are in board/. But they still should be called
> readme.md :-)
IIUC, github et al. expect README.md to contain Markdown, not plain
text. A simple README (or maybe readme as well) would still be
displayed, but no rednering would be done.
In any case, this is a topic for a completely different series.
Regards,
Yann E. MORIN.
--
.-----------------.--------------------.------------------.--------------------.
| Yann E. MORIN | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software Designer | \ / CAMPAIGN | ___ |
| +33 223 225 172 `------------.-------: X AGAINST | \e/ There is no |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL | v conspiracy. |
'------------------------------^-------^------------------^--------------------'
More information about the buildroot
mailing list