[haiku-development] [RFC] ReadMe vs. ReadMe.IntroductionToHaiku
- From: Augustin Cavalier <waddlesplash@xxxxxxxxx>
- To: "haiku-development@xxxxxxxxxxxxx" <haiku-development@xxxxxxxxxxxxx>
- Date: Wed, 4 Feb 2015 20:00:45 -0500
Hi all,
Currently we have 2 READMEs in the root of the repository: "ReadMe" [1] and
"ReadMe.IntroductionToHaiku" [2]. The former mostly describes how to build
/ use Haiku, the latter is an introduction to what Haiku is, why it exists,
etc.
I propose we rename "ReadMe" to "ReadMe.Compiling" and
"ReadMe.IntroductionToHaiku" to (after some cleanup), "ReadMe" for the
following reasons:
* Most users, when presented with a new repository, will just go for
"ReadMe" for a general overview of the contents
* Code search engines tend to target the main ReadMe for a description /
overview of the project
* GitHub displays the contents (in full) of just one ReadMe.
Thoughts? Comments? Concerns?
-Augustin
[1]: http://cgit.haiku-os.org/haiku/tree/ReadMe
[2]: http://cgit.haiku-os.org/haiku/tree/ReadMe.IntroductionToHaiku
Other related posts:
