[lkml]   [2017]   [May]   [1]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
Messages in this thread
SubjectRe: [PATCH] README: Find more sane first words we have to say about Linux
Am 2017-05-01 um 17:24 schrieb Jonathan Corbet:
> On Sun, 30 Apr 2017 22:11:35 +0200
> Martin Kepplinger <> wrote:
>> Imagine you're completely new to Linux, just real quick, ok? What do you do?
>> Wouldn't having a look at README be under first if no *the* first thing?
>> Ah there it is: README. "Linux kernel". nice! So what's that?
>> "This file was moved to ...... Please notice that there are several....".
>> Wtf!? Why? Can't they just tell me what's going on like a normal person?
> So I don't doubt we could put something better there, but can we think for
> a moment about who the audience is here? If you're "completely new to
> Linux", will you really start by jumping into the kernel source tree?
> Somehow I'm not quite convinced... It seems to me that the README file
> should be aimed at developers who know what the kernel is but are not yet
> familiar with the process of configuring and building it.

It should definitely be aimed at developers. But even as a developer who
is completely new to kernel development, it's nice to have some broad
context in 2 or 3 lines first.

(again, I'm a little exaggerating and) trying to see from an outside
point of view:
What other "official brief definition" of what Linux is could there be?
Right now one has the impression that the Linux Foundation has
"official" information, but that's (very strictly speaking) pretty
random right? Besides developers, I can imagine technical literature to
have a look at projects' README files for that.

I mean there *is* the new README.rst which is awesome. But it wouldn't
hurt to summarize the first few things in the README and then refer to
the doc. It should be something for people who

* already checked out the source obviously (developers, but or technical
authors, or any interested engineer), and

* who would *maybe* say, "what? nothing in the README? ok. I'll take
some definition I found online then" and not bother reading the
Documentation directory just yet.


 \ /
  Last update: 2017-05-01 18:02    [W:0.045 / U:0.256 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site