Skip to content

Commit 6bef44b

Browse files
committed
README: add a new README file, pointing to the Documentation/
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>
1 parent 08a9a8d commit 6bef44b

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Linux kernel
2+
============
3+
4+
This file was moved to Documentation/admin-guide/README.rst
5+
6+
Please notice that there are several guides for kernel developers and users.
7+
These guides can be rendered in a number of formats, like HTML and PDF.
8+
9+
In order to build the documentation, use ``make htmldocs`` or
10+
``make pdfdocs``.
11+
12+
There are various text files in the Documentation/ subdirectory,
13+
several of them using the Restructured Text markup notation.
14+
See Documentation/00-INDEX for a list of what is contained in each file.
15+
16+
Please read the Documentation/process/changes.rst file, as it contains the
17+
requirements for building and running the kernel, and information about
18+
the problems which may result by upgrading your kernel.

0 commit comments

Comments
 (0)