Blame view

README 727 Bytes
6bef44b9b   Mauro Carvalho Chehab   README: add a new...
1
2
  Linux kernel
  ============
9f4a68e41   Martin Kepplinger   README: Improve d...
3
4
5
  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.
6bef44b9b   Mauro Carvalho Chehab   README: add a new...
6
7
  
  In order to build the documentation, use ``make htmldocs`` or
4b290af0b   Jonathan Corbet   Docs: Added a poi...
8
9
10
  ``make pdfdocs``.  The formatted documentation can also be read online at:
  
      https://www.kernel.org/doc/html/latest/
6bef44b9b   Mauro Carvalho Chehab   README: add a new...
11
12
13
  
  There are various text files in the Documentation/ subdirectory,
  several of them using the Restructured Text markup notation.
6bef44b9b   Mauro Carvalho Chehab   README: add a new...
14
15
16
17
  
  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.