Skip to content

Commit

Permalink
Docs: Added a pointer to the formatted docs to README
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Jonathan Corbet committed Mar 21, 2018
1 parent 9f4a68e commit 4b290af
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ 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``.
``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,
several of them using the Restructured Text markup notation.
Expand Down

0 comments on commit 4b290af

Please sign in to comment.