Skip to content

Update README #1168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions README

This file was deleted.

69 changes: 69 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
```
__ _
/ / (_)___ __ ___ __
/ / / / __ \/ / / / |/_/
/ /___/ / / / / /_/ /> <
/_____/_/_/ /_/\__,_/_/|_|

K E R N E L P R O J E C T

```

# Linux Kernel Documentation

Welcome to the Linux kernel documentation! Here you'll find comprehensive guides
for both kernel developers and users.

## Quick Start Guide

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| .'
`-' `--'
```