Messages in this thread Patch in this message |  | | From | Martin Kepplinger <> | Subject | [PATCH] README: Find more sane first words we have to say about Linux | Date | Sun, 30 Apr 2017 22:11:35 +0200 |
| |
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
|  |