mirror of
https://github.com/torvalds/linux.git
synced 2024-11-21 19:41:42 +00:00
9f4a68e416
"This file" indeed was moved once, but at some point "this file", the top-level README, becomes a file in itself. Now that time has come :) Let's describe how things are, and suggest reading "this file" first, "this file" simply being a the admin-guide README file, not a file that was once moved. Signed-off-by: Martin Kepplinger <martink@posteo.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
18 lines
698 B
Plaintext
18 lines
698 B
Plaintext
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``.
|
|
|
|
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.
|