system/linux
system/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux synced 2024-10-01 17:00:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

README: Fix grammatical & punctuation errors, markdown-ify, clickable URLs, improved reading clarity

Browse source 
- Fixed grammatical errors: 
    - "which ... by upgrading"   -> which ... from upgrading"

- Fixed punctuation (incorrectly added comma):
    - "building and, running"     -> "building and running"

- Improved reading clarity:
    - "In a number of formats"  -> "In several formats"
    - "In order to build the"       -> "To build the"
    - "several of them using"    -> "several using"

- Updated file to markdown, while maintaining past formatting

- Links are now hyperlinks, facilitating use
This commit is contained in:
arthur 2024-04-05 20:53:37 +13:00 committed by GitHub
parent 8cb4a9a82b
commit 39de45d8da
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 25 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README
View file

@ -1,18 +0,0 @@
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:
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.

25
README.md Normal file
View file

@ -0,0 +1,25 @@
Linux kernel
============
There are several guides for kernel developers and users. These guides can
<br />be rendered in several formats, like HTML and PDF. Please read
<br />[Documentation/admin-guide/README.rst](https://github.com/torvalds/linux/blob/master/Documentation/admin-guide/README.rst) first.
To build the documentation, use ``make htmldocs`` or
<br />``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/](https://github.com/torvalds/linux/blob/master/Documentation/) subdirectory,
<br />several using the reStructuredText markup notation.
Please read the [Documentation/process/changes.rst](https://github.com/torvalds/linux/blob/master/Documentation/process/changes.rst) file, as it contains the
<br />requirements for building and running the kernel and information about
<br />the problems that may result from upgrading your kernel.
[//]: # (me: Let me install nginx)
[//]: # (windows: noo!! it will break your PC!)
[//]: # (me: can I uninstall the bootloader?)
[//]: # (linux: sure, go ahead lol)