diff --git a/README b/README.md similarity index 88% rename from README rename to README.md index fd903645e6de..4ef1ffff2cf4 100644 --- a/README +++ b/README.md @@ -1,14 +1,11 @@ -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. 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/ +``make pdfdocs``. The formatted documentation can also be read online at [here](https://www.kernel.org/doc/html/latest/) There are various text files in the Documentation/ subdirectory, several of them using the reStructuredText markup notation.