README

   1 Linux kernel
   2 ============
   3
   4 There are several guides for kernel developers and users. These guides can
   5 be rendered in a number of formats, like HTML and PDF. Please read
   6 Documentation/admin-guide/README.rst first.
   7
   8 In 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
  13 There are various text files in the Documentation/ subdirectory,
  14 several of them using the Restructured Text markup notation.
  15 See Documentation/00-INDEX for a list of what is contained in each file.
  16
  17 Please read the Documentation/process/changes.rst file, as it contains the
  18 requirements for building and running the kernel, and information about
  19 the problems which may result by upgrading your kernel.