Skip to content

Commit

Permalink
README: add a new README file, pointing to the Documentation/
Browse files Browse the repository at this point in the history
As we moved the real README file to Documentation/admin-guide/README.rst,
let's add a replacement, pointing to it, and giving the main directions
about documentation.

In the future, perhaps it would be worth to move the contents
of Documentation/00-Index into this README.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
  • Loading branch information
mchehab committed Oct 24, 2016
1 parent 08a9a8d commit 6bef44b
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README
@@ -0,0 +1,18 @@
Linux kernel
============

This file was moved to Documentation/admin-guide/README.rst

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.

In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``.

There are various text files in the Documentation/ subdirectory,
several of them using the Restructured Text markup notation.
See Documentation/00-INDEX for a list of what is contained in each file.

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.

0 comments on commit 6bef44b

Please sign in to comment.