diff --git a/README b/README.md similarity index 74% rename from README rename to README.md index 669ac7c3229279..7519ad7ee35c38 100644 --- a/README +++ b/README.md @@ -1,17 +1,14 @@ -Linux kernel -============ + # 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. +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/ +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 Restructured Text markup notation. +There are various text files in the Documentation/ subdirectory,several of them using the Restructured Text markup notation. Please read the Documentation/process/changes.rst file, as it contains the requirements for building and running the kernel, and information about