[m-dev.] Shifting README files into a subdirectory
Peter Wang
novalazy at gmail.com
Thu Dec 18 11:59:09 AEDT 2025
On Thu, 18 Dec 2025 11:42:09 +1100 "Zoltan Somogyi" <zoltan.somogyi at runbox.com> wrote:
>
>
> On Wed, 17 Dec 2025 17:21:20 +1100, Julien Fischer <jfischer at opturion.com> wrote:
> > Zoltan suggested moving all but the main README file into a subdirectory
> > some time ago.
>
> Obviously, I approve.
>
> > I propose we name the new subdirectory "guides" and make
> > this change.
>
> I would propose something like READMES, READMES.x or READMES.system_specific
> for the name of this directory, just to make clear that it contains more README files.
I think "guides" or even "readmes" will get lost in the other
directories. I don't especially like "READMES" etc, though.
> By the way, we could also replace the HISTORY file with a HISTORY directory,
> with one file per major release. That would make a grep for e.g. a predicate name
> more useful, as grep will tell you immediately which release the match is for,
> without needing to look in the file for the immediately previous major release heading.
> Do you guys agree with doing this?
>
One history file per release would be good. I have wanted that before.
Some projects have a "Documentation" directory. If we follow that
convention, we could place the additional READMEs, (old) release notes,
and so on, in there as well.
If having both "Documentation" and "doc" is a concern, we could consider
renaming "doc".
Peter
More information about the developers
mailing list