mirror of
https://github.com/torvalds/linux.git
synced 2024-11-01 04:53:36 +01:00
Create README.md
This commit is contained in:
parent
87a001182b
commit
e7f67f0eb3
1 changed files with 15 additions and 0 deletions
15
README.md
Normal file
15
README.md
Normal file
|
@ -0,0 +1,15 @@
|
|||
# Linux kernel
|
||||
|
||||
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.
|
||||
|
||||
In order to build the documentation, use ``make htmldocs`` or
|
||||
``make pdfdocs``. The formatted documentation can also be read online at [here](https://www.kernel.org/doc/html/latest/)
|
||||
|
||||
There are various text files in the Documentation/ subdirectory,
|
||||
several of them using the reStructuredText markup notation.
|
||||
|
||||
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.
|
Loading…
Reference in a new issue