mirror of
https://github.com/torvalds/linux.git
synced 2024-11-24 21:21:41 +00:00
Docs: Added a pointer to the formatted docs to README
Kernel.org nicely maintains an online copy of the formatted documentation; tell our users that it exists. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
parent
9f4a68e416
commit
4b290af0b3
4
README
4
README
@ -6,7 +6,9 @@ be rendered in a number of formats, like HTML and PDF. Please read
|
|||||||
Documentation/admin-guide/README.rst first.
|
Documentation/admin-guide/README.rst first.
|
||||||
|
|
||||||
In order to build the documentation, use ``make htmldocs`` or
|
In order to build the documentation, use ``make htmldocs`` or
|
||||||
``make pdfdocs``.
|
``make pdfdocs``. The formatted documentation can also be read online at:
|
||||||
|
|
||||||
|
https://www.kernel.org/doc/html/latest/
|
||||||
|
|
||||||
There are various text files in the Documentation/ subdirectory,
|
There are various text files in the Documentation/ subdirectory,
|
||||||
several of them using the Restructured Text markup notation.
|
several of them using the Restructured Text markup notation.
|
||||||
|
Loading…
Reference in New Issue
Block a user