From bc11f79c386a08a899e755a6c021e363c1f2f3da Mon Sep 17 00:00:00 2001
From: 5kind <shikabane320@gmail.com>
Date: Wed, 20 Dec 2023 23:48:40 +0800
Subject: [PATCH] lxc docker action readme

---
 README.md    | 28 ++++++++++++++++++++++++++++
 README_EN.md | 28 ++++++++++++++++++++++++++++
 2 files changed, 56 insertions(+)

diff --git a/README.md b/README.md
index 22b3beb9ef..4cb208965c 100644
--- a/README.md
+++ b/README.md
@@ -161,6 +161,34 @@ LTO 用于优化内核，但有些时候会导致错误
 
 例如: https://raw.githubusercontent.com/xiaoleGun/KernelSU_action/main/boot/boot-wayne-from-Miku-UI-latest.img
 
+# LXC-DOCKER Action
+
+### KERNEL_DEPTH
+
+内核源码深度，一般为 1 已经足够
+
+### CUT_PYTHON
+
+修改默认 python 为 python2
+
+### LXC_DOCKER | ENABLE_KVM | ANDROID_PARANOID_NETWORK_OFF
+
+启用 lxc-docker | kvm 的内核配置 | 关闭 Android 网络配置(防止容器网络问题)
+
+### ENABLE_NETHUNTER
+
+启用 nethunter 的内核配置，并运行[patch脚本](scripts/patch/kali-nethunter-kernel.sh)，按需自定义
+
+### LXC_PATCH | MAKEFILE_PATCH
+
+进行 lxc-docker | Makefile 的 patch
+- lxc-docker: 运行[patch脚本](scripts/patch/lxc-docker.sh)，按需自定义
+- Makefile: 如果默认的配置覆盖了使用的配置时[进行patch](patches/Makefile.patch)，按需自定义
+
+### CUSTOM_SCRIPT
+
+是否运行[自定义脚本](scripts/customize.sh)，按需自定义
+
 ## 感谢
 
 - [AnyKernel3](https://github.com/osm0sis/AnyKernel3)
diff --git a/README_EN.md b/README_EN.md
index f408cbbe9d..ddf9d22585 100644
--- a/README_EN.md
+++ b/README_EN.md
@@ -151,6 +151,34 @@ As the name suggests, it provides a boot image source system that can boot norma
 
 For example: https://raw.githubusercontent.com/xiaoleGun/KernelSU_action/main/boot/boot-wayne-from-Miku-UI-latest.img
 
+# LXC-DOCKER Action
+
+### KERNEL_DEPTH
+
+Kernel source code depth, usually 1 is sufficient.
+
+### CUT_PYTHON
+
+Change the default Python to Python2.
+
+### LXC_DOCKER | ENABLE_KVM | ANDROID_PARANOID_NETWORK_OFF
+
+Enable the kernel configuration for lxc-docker | kvm | turn off Android network configuration (to prevent container network issues).
+
+### ENABLE_NETHUNTER
+
+Enable the kernel configuration for nethunter, and run the [patch script](scripts/patch/kali-nethunter-kernel.sh) to customize as needed.
+
+### LXC_PATCH | MAKEFILE_PATCH
+
+Perform patching for lxc-docker | Makefile.
+- lxc-docker: run the [patch script](scripts/patch/lxc-docker.sh) to customize as needed.
+- Makefile: if the default configuration overrides the used configuration, [perform patching](patches/Makefile.patch) and customize as needed.
+
+### CUSTOM_SCRIPT
+
+Whether to run the [customization script](scripts/customize.sh) and customize as needed.
+
 ## Thanks
 
 - [AnyKernel3](https://github.com/osm0sis/AnyKernel3)