From 1df83a17198ef094e61c128628c652d9f3bae4c2 Mon Sep 17 00:00:00 2001 From: Arsalan Mohseni <138380466+arsalanmohseni@users.noreply.github.com> Date: Sat, 5 Oct 2024 18:24:08 +0330 Subject: [PATCH 1/3] Fixed lint errors of README --- README | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README b/README index fd903645e6de..4ef1ffff2cf4 100644 --- a/README +++ b/README @@ -1,14 +1,11 @@ -Linux kernel -============ +# 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/ +``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. From 87a001182b59e014450f352c5ab04d5503ab78c5 Mon Sep 17 00:00:00 2001 From: Arsalan Mohseni <138380466+arsalanmohseni@users.noreply.github.com> Date: Sat, 5 Oct 2024 18:28:21 +0330 Subject: [PATCH 2/3] Delete README to change format to md --- README | 15 --------------- 1 file changed, 15 deletions(-) delete mode 100644 README diff --git a/README b/README deleted file mode 100644 index 4ef1ffff2cf4..000000000000 --- a/README +++ /dev/null @@ -1,15 +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 [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. From e7f67f0eb3bbe50813d14714366ca12c428c86ab Mon Sep 17 00:00:00 2001 From: Arsalan Mohseni <138380466+arsalanmohseni@users.noreply.github.com> Date: Sat, 5 Oct 2024 18:29:31 +0330 Subject: [PATCH 3/3] Create README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000000..4ef1ffff2cf4 --- /dev/null +++ b/README.md @@ -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.