From 327583b549614bb4ca52097e0fc4ef1e77c919f8 Mon Sep 17 00:00:00 2001 From: Shibedev12 <100108102+Shibedev12@users.noreply.github.com> Date: Fri, 17 Jan 2025 00:30:21 -0600 Subject: [PATCH 1/4] Update README --- README | 91 +++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 78 insertions(+), 13 deletions(-) diff --git a/README b/README index fd903645e6de06..bc1ddb91facf55 100644 --- a/README +++ b/README @@ -1,18 +1,83 @@ -Linux kernel -============ +``` + __ _ + / / (_)___ __ ___ __ + / / / / __ \/ / / / |/_/ + / /___/ / / / / /_/ /> < + /_____/_/_/ /_/\__,_/_/|_| + + K E R N E L P R O J E C T -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. + , , + / \/ \ + (/ //_ \_ + .--------------/ / \_/ \-----------------------------------------. + | _____/ / \/ ) | + | `----/ / / | + | / / / | + | / / / | + | / / / | + | _____ / / | + | `----_/ / | + | / / | + | / / Linux Documentation | + | / / | + | ____/ / | + |/_________/ | + |_____________________________________________________________| -In order to build the documentation, use ``make htmldocs`` or -``make pdfdocs``. The formatted documentation can also be read online at: +# Linux Kernel Documentation - https://www.kernel.org/doc/html/latest/ +Welcome to the Linux kernel documentation! Here you'll find comprehensive guides +for both kernel developers and users. -There are various text files in the Documentation/ subdirectory, -several of them using the reStructuredText markup notation. +## Quick Start Guide -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. +Before diving in, please read `Documentation/admin-guide/README.rst` first. This +will give you the essential foundation you need. + +## Available Formats + +Build the documentation in your preferred format: + +```bash +make htmldocs # Generate HTML documentation +make pdfdocs # Generate PDF documentation +``` + +Browse the latest documentation online at: +https://www.kernel.org/doc/html/latest/ + +## Documentation Overview + +* The `Documentation/` directory contains various text files using + reStructuredText markup +* Each subsystem typically has its own documentation folder +* Documentation covers everything from basic usage to advanced development + +## Important Notice + +📢 Before upgrading your kernel, always read `Documentation/process/changes.rst`. +This critical document covers: + +* Build requirements +* Runtime requirements +* Potential upgrade issues +* Common solutions + + Happy hacking! + _nnnn_ + dGGGGMMb + @p~qp~~qMb + M|@||@) M| + @,----.JM| + JS^\__/ qKL + dZP qKRb + dZP qKKb + fZP SMMb + HZM MMMM + FqM MMMM + __| ". |\dS"qML + | `. | `' \Zq + _) \.___.,| .' + \____ )MMMMMP| .' + `-' `--' From 7abf41289aa2701550bd54bc4c02f04866e4975a Mon Sep 17 00:00:00 2001 From: Shibedev12 <100108102+Shibedev12@users.noreply.github.com> Date: Mon, 10 Mar 2025 01:10:59 -0500 Subject: [PATCH 2/4] Update README --- README | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/README b/README index bc1ddb91facf55..80acf40d547086 100644 --- a/README +++ b/README @@ -7,23 +7,6 @@ K E R N E L P R O J E C T - , , - / \/ \ - (/ //_ \_ - .--------------/ / \_/ \-----------------------------------------. - | _____/ / \/ ) | - | `----/ / / | - | / / / | - | / / / | - | / / / | - | _____ / / | - | `----_/ / | - | / / | - | / / Linux Documentation | - | / / | - | ____/ / | - |/_________/ | - |_____________________________________________________________| # Linux Kernel Documentation From 359d72ac337e4826a08101a7570b3133274b9ea6 Mon Sep 17 00:00:00 2001 From: Shibedev12 <100108102+Shibedev12@users.noreply.github.com> Date: Mon, 10 Mar 2025 01:11:33 -0500 Subject: [PATCH 3/4] Update README --- README | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README b/README index 80acf40d547086..e7b4017884617e 100644 --- a/README +++ b/README @@ -7,6 +7,7 @@ K E R N E L P R O J E C T +``` # Linux Kernel Documentation @@ -48,6 +49,7 @@ This critical document covers: * Common solutions Happy hacking! +``` _nnnn_ dGGGGMMb @p~qp~~qMb @@ -64,3 +66,4 @@ This critical document covers: _) \.___.,| .' \____ )MMMMMP| .' `-' `--' +``` From 722e6caf1fde27c5648118980a5ce82b122987f4 Mon Sep 17 00:00:00 2001 From: Shibedev12 <100108102+Shibedev12@users.noreply.github.com> Date: Mon, 10 Mar 2025 01:16:19 -0500 Subject: [PATCH 4/4] Rename README to README.md --- README => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README => README.md (100%) diff --git a/README b/README.md similarity index 100% rename from README rename to README.md