Skip to content

docs: add FAQ for new contributors #41068

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
Jishnu09-siuu wants to merge 1 commit into
base: README
Choose a base branch
from
Open

docs: add FAQ for new contributors #41068

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
23 changes: 23 additions & 0 deletions docs/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Frequently Asked Questions (FAQ)
## What is Xiaomi Kernel OpenSource?
This repository contains Linux kernel source code released by Xiaomi for supported Xiaomi, Redmi, and POCO devices. Developers can use these sources to build custom kernels and contribute improvements.
## What is a kernel source?
The Linux kernel is the core of the Android operating system. Kernel source code allows developers to build custom kernels, fix bugs, and improve hardware support.
## Which branch should I use?
Each device has its own kernel branch.

Find your device in the README and use the branch listed for your device.
## How do I know my device codename?
You can check your device codename using:

adb shell getprop ro.product.device

Then search for that codename in the README.
## Why isn't my device listed?
Possible reasons include:

- Xiaomi has not released the kernel source.
- The repository has not yet been updated.
- Your device uses another codename.
## What compiler is required?
The required compiler depends on the specific kernel branch. Refer to the branch documentation or build scripts for the recommended compiler version.