diff --git a/README.md b/README.md new file mode 100644 index 000000000..f49002d5a --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Upstream Linux 6.1 LTS for CoolPi RK3588 devices +## Description +This kernel is based on the **rk-6.1-rkr5** branch of the **Armbian Rockchip Linux 6.1 LTS** kernel with patches sourced from the **linux-6.1-stan-rkr3.1** branch of the **CoolPi Linux 6.1 LTS** kernel to support **CoolPi** devices. + +Additional patches for the **Armbian** and **CoolPi** kernels are applied as they are released. Patch commit status can be verified by either running the **build-kernel.sh** script or by referring to the files containing the patch commit hashes that the build script reads from: **armbian-rk-6.1-rkr5-patch-release** and **coolpi-linux-6.1-stan-rkr3.1-patch-release** + +This kernel aims to always be on the latest **Linux 6.1 LTS upstream release**. + +## Kernel Testing Information +The device used to test this kernel is a CoolPi CM5 NoteBook v20. + +## Credits and Sources +| Repository | Branch | Organization | +|-------------------------------------------------------------|----------------------------------------------------------------|--------------| +| [linux-rockchip](https://github.com/armbian/linux-rockchip) | [rk-6.1-rkr5](https://github.com/armbian/linux-rockchip/tree/rk-6.1-rkr5) | Armbian +| [coolpi-kernel](https://github.com/coolpi-george/coolpi-kernel) | [linux-6.1-stan-rkr3.1](https://github.com/coolpi-george/coolpi-kernel/tree/linux-6.1-stan-rkr3.1) | CoolPi + +## Linux Kernel Default README +[README](README)