From e1bf2b3ef14b648e599733c78e76b33bd463100d Mon Sep 17 00:00:00 2001
From: jiangcuo <jiangcuo@bingsin.com>
Date: Sun, 5 Nov 2023 15:57:36 +0800
Subject: [PATCH] add help

---
 README.md         | 10 +++--
 help/helpindex.md |  9 +++++
 help/kernel.md    | 95 +++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 111 insertions(+), 3 deletions(-)
 create mode 100644 help/helpindex.md
 create mode 100644 help/kernel.md

diff --git a/README.md b/README.md
index 4da5df1..d0b46dd 100644
--- a/README.md
+++ b/README.md
@@ -33,11 +33,15 @@ Master branch is mirror, checkout branch to arm64 / riscv64 / loongarch64 .You c
 
 ## 3. Support 
 
-mail: jiangcuo@bingsin.com
+Mail: jiangcuo@bingsin.com
 
-issue: https://github.com/jiangcuo/Proxmox-Arm64/issues
+Issue: https://github.com/jiangcuo/Proxmox-Arm64/issues
 
-discord: https://discord.gg/ZdbD2gDcnP
+Discord: https://discord.gg/ZdbD2gDcnP
+
+Help Page: [help.md](help/helpindex.md)
+
+Arm64 wiki: https://github.com/jiangcuo/Proxmox-Arm64/wiki
 
 
 ## 4. Tested platform:
diff --git a/help/helpindex.md b/help/helpindex.md
new file mode 100644
index 0000000..3fafa75
--- /dev/null
+++ b/help/helpindex.md
@@ -0,0 +1,9 @@
+# Help
+
+## Kernel
+
+[kernel.md](./kernel.md)
+
+## Port Registry
+
+[repo.md](./repo.md)
diff --git a/help/kernel.md b/help/kernel.md
new file mode 100644
index 0000000..e6169ae
--- /dev/null
+++ b/help/kernel.md
@@ -0,0 +1,95 @@
+# Proxmox Port Kernel
+
+I forked a kernel project:
+
+ `https://github.com/jiangcuo/pve-port-kernel.git`
+
+The pre-build kernel file of this project is stored in the repo:
+
+`deb https://global.mirrors.apqa.cn/proxmox/debian/kernel sid port`
+
+Currently, there are two architectures: LoongArch64 and ARM64.
+
+The config in the kernel selects all arm64 devices and can theoretically be used for all.
+
+## 1. How to install the kernel
+
+### 1.1 Use apt
+
+```bash
+#add repo
+$ echo "deb https://global.mirrors.apqa.cn/proxmox/debian/kernel sid port" >>  /etc/apt/sources.list.d/pveport.list
+
+#fresh 
+$ apt update
+
+#Lists the available kernels
+$ apt search pve-kernel
+
+#install latest kernel by metapackage
+$ apt install pve-kernel-6.1-generic
+```
+
+### 1.2 Use dpkg
+
+download kernel package form project releases or repo, use
+`dpkg -i pve-kernel-*` to install.
+
+### 1.3 Boot from new kernel
+
+A PC booted with  should automatically  set the latest kernel as the first boot kernel. You just need reboot to apply.
+
+If you encounter a failure with a new kernel ,reboot to grub, select Advanced, and in the next options, select the previous kernel.
+
+
+### 1.3 uboot devices
+
+The uboot device will  read the  `/{boot_partition}/extlinux/extlinux.conf` file on the boot.
+
+```bash
+# if your boot_partition is /dev/mmcblk0p3
+$ mount /dev/mmcblk0p3 /opt
+# if pve kernel vmlinuz is vmlinuz-6.1.60-generic
+$ cp /boot/vmlinuz-6.1.60-generic /opt
+$ sync
+```
+
+
+You can edit your extlinux.conf.
+```bash
+$ nano /opt/extlinux/extlinux.conf
+```
+```
+default l0
+menu title QuartzPro64 Boot Menu
+prompt 0
+timeout 50
+
+# create a new item with new kernel.
+label l0
+menu label Boot Linux Kernel SDMMC
+linux /vmlinuz-6.1.60-generic
+fdt /rk3588-quartzpro64.dtb
+append earlycon=uart8250,mmio32,0xfeb50000 console=ttyS2,1500000n8 root=/dev/mmcblk1p5 rw rootwait
+
+# backup old boot item
+label 20
+menu label Boot Linux Kernel SDMMC Backup
+linux /Image
+fdt /rk3588-quartzpro64.dtb
+append earlycon=uart8250,mmio32,0xfeb50000 console=ttyS2,1500000n8 root=/dev/mmcblk1p5 rw rootwait
+```
+
+The kernel package has compiled the DTB file, if you need it, you can go to the "/boot/dtbs/{kernel_version}/" folder.
+
+!!! NOTE
+
+*** Make sure you can access your device using the serial port. If your changes are wrong, you may not be able to boot the system, so you have a serial port that you can debug again. ***
+
+
+
+## 2. Manual build
+
+See https://github.com/jiangcuo/pve-port-kernel readme.md
+
+