linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Martin Kepplinger <martink@posteo.de>
To: mchehab@kernel.org, akpm@linux-foundation.org, corbet@lwn.net,
	torvalds@linux-foundation.org
Cc: linux-kernel@vger.kernel.org, Martin Kepplinger <martink@posteo.de>
Subject: [PATCH] README: Find more sane first words we have to say about Linux
Date: Sun, 30 Apr 2017 22:11:35 +0200	[thread overview]
Message-ID: <20170430201135.11603-1-martink@posteo.de> (raw)

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?

I'm sorry for the exaggeration, but really honestly I think we could do better.
I'm all for not really having content in README, but come on :)

I only try to avoid the biggest damage here and find some nice first words
at least.

Signed-off-by: Martin Kepplinger <martink@posteo.de>
---

please ignore if too irrelevant, but I personally would put this in 4.11,
if still possible, and rewrite the REAME for 4.12 to be even more friendly.

thanks
                         martin



 README | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/README b/README
index b2ba4aaa3a71..876a98a5d472 100644
--- a/README
+++ b/README
@@ -1,10 +1,11 @@
 Linux kernel
 ============
 
-This file was moved to Documentation/admin-guide/README.rst
+Linux is a Unix-like operating system, originally written by Linus Torvalds.
+Please read Documentation/admin-guide/README.rst for an introduction.
 
-Please notice that there are several guides for kernel developers and users.
-These guides can be rendered in a number of formats, like HTML and PDF.
+There are several guides for kernel developers and users. These guides can be
+rendered in a number of formats, like HTML and PDF.
 
 In order to build the documentation, use ``make htmldocs`` or
 ``make pdfdocs``.
-- 
2.11.0

             reply	other threads:[~2017-04-30 20:11 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-04-30 20:11 Martin Kepplinger [this message]
2017-05-01 15:24 ` [PATCH] README: Find more sane first words we have to say about Linux Jonathan Corbet
2017-05-01 16:01   ` Martin Kepplinger

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170430201135.11603-1-martink@posteo.de \
    --to=martink@posteo.de \
    --cc=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=torvalds@linux-foundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).