xref: /linux/README (revision b1a54551dd9ed5ef1763b97b35a0999ca002b95c)
1Linux kernel
2============
3
4There are several guides for kernel developers and users. These guides can
5be rendered in a number of formats, like HTML and PDF. Please read
6Documentation/admin-guide/README.rst first.
7
8In order to build the documentation, use ``make htmldocs`` or
9``make pdfdocs``.  The formatted documentation can also be read online at:
10
11    https://www.kernel.org/doc/html/latest/
12
13There are various text files in the Documentation/ subdirectory,
14several of them using the ReStructured Text markup notation.
15
16Please read the Documentation/process/changes.rst file, as it contains the
17requirements for building and running the kernel, and information about
18the problems which may result by upgrading your kernel.
19