From 39de45d8da5ef3c82d9c014a36ae3d80826cf1ae Mon Sep 17 00:00:00 2001
From: arthur <51604173+arthurauffray@users.noreply.github.com>
Date: Fri, 5 Apr 2024 20:53:37 +1300
Subject: [PATCH] README: Fix grammatical & punctuation errors, markdown-ify,
clickable URLs, improved reading clarity
- Fixed grammatical errors:
- "which ... by upgrading" -> which ... from upgrading"
- Fixed punctuation (incorrectly added comma):
- "building and, running" -> "building and running"
- Improved reading clarity:
- "In a number of formats" -> "In several formats"
- "In order to build the" -> "To build the"
- "several of them using" -> "several using"
- Updated file to markdown, while maintaining past formatting
- Links are now hyperlinks, facilitating use
---
README | 18 ------------------
README.md | 25 +++++++++++++++++++++++++
2 files changed, 25 insertions(+), 18 deletions(-)
delete mode 100644 README
create mode 100644 README.md
diff --git a/README b/README
deleted file mode 100644
index fd903645e6de..000000000000
--- a/README
+++ /dev/null
@@ -1,18 +0,0 @@
-Linux kernel
-============
-
-There are several guides for kernel developers and users. These guides can
-be rendered in a number of formats, like HTML and PDF. Please read
-Documentation/admin-guide/README.rst first.
-
-In order to build the documentation, use ``make htmldocs`` or
-``make pdfdocs``. The formatted documentation can also be read online at:
-
- https://www.kernel.org/doc/html/latest/
-
-There are various text files in the Documentation/ subdirectory,
-several of them using the reStructuredText markup notation.
-
-Please read the Documentation/process/changes.rst file, as it contains the
-requirements for building and running the kernel, and information about
-the problems which may result by upgrading your kernel.
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..2c05ea13e123
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+Linux kernel
+============
+
+There are several guides for kernel developers and users. These guides can
+
be rendered in several formats, like HTML and PDF. Please read
+
[Documentation/admin-guide/README.rst](https://github.com/torvalds/linux/blob/master/Documentation/admin-guide/README.rst) first.
+
+To build the documentation, use ``make htmldocs`` or
+
``make pdfdocs``. The formatted documentation can also be read online at:
+
+ https://www.kernel.org/doc/html/latest/
+
+
+There are various text files in the [Documentation/](https://github.com/torvalds/linux/blob/master/Documentation/) subdirectory,
+
several using the reStructuredText markup notation.
+
+Please read the [Documentation/process/changes.rst](https://github.com/torvalds/linux/blob/master/Documentation/process/changes.rst) file, as it contains the
+
requirements for building and running the kernel and information about
+
the problems that may result from upgrading your kernel.
+
+[//]: # (me: Let me install nginx)
+[//]: # (windows: noo!! it will break your PC!)
+[//]: # (me: can I uninstall the bootloader?)
+[//]: # (linux: sure, go ahead lol)
+