Skip to content

Update and rename README to README.md #1201

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.

Sign up for GitHub

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 1 commit into
base: master
Choose a base branch
from
Open

Update and rename README to README.md #1201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop

This file was deleted.

23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Linux Kernel

Welcome to the **Linux Kernel** source repository!

This repository contains the source code and documentation for the Linux Kernel. Whether you're a developer, a contributor, or simply curious about how the kernel works, you've come to the right place.

---

## Documentation

Several helpful guides exist for both **kernel developers** and **users**. These are available in multiple formats such as **HTML** and **PDF**.

Start by reading: `Documentation/admin-guide/README.rst`

---

## Building the Documentation

To generate documentation locally, run:

```bash
make htmldocs # Build HTML documentation
make pdfdocs # Build PDF documentation