From d5cb88267426264081faf0bbc120ddc120ebd25a Mon Sep 17 00:00:00 2001 From: Kilian Friedrich <38128547+friedrichkilian@users.noreply.github.com> Date: Fri, 14 Feb 2020 19:21:29 +0100 Subject: [PATCH] Create README.md to replace existing README (which isn't displayed like intended) --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000000000..669ac7c3229279 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +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 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 +the problems which may result by upgrading your kernel.