From: strongtz <strongtz@yeah.net>
Date: 星期一, 8 Feb 2021 13:57:40 +0000 (+0000)
Subject: Documents update
X-Git-Tag: v0.2~2
X-Git-Url: https://git.renegade-project.org/?a=commitdiff_plain;h=d48ea1de2e04e4176507ae1b1f9fdad49b809f2e;p=edk2-sdm845.git

Documents update
---

diff --git a/README.md b/README.md
index ad7ed6b..0b96597 100644
--- a/README.md
+++ b/README.md
@@ -61,36 +61,8 @@ fastboot boot boot_DEVICE.img
 To be filled soon
 
 ## Porting Guide
- 
- 1. Install Python protobuf and uefi_firmware-parser by executing `pip install --upgrade google-api-python-client uefi_firmware` in terminal
- 2. Download [extract_android_ota_payload](https://github.com/cyxx/extract_android_ota_payload/archive/master.zip) and extract the folder inside the archive anywhere
- 3. Download any OTA update for your phone
- 4. Extract payload.bin to `extract_android_ota_payload-master` folder
- 5. Open terminal in the same folder and execute `python3 extract_android_ota_payload.py payload.bin`
- 6. Execute `uefi-firmware-parser -b -e xbl.img`
- 7. Change directory to `volume-******/file-9e21fd93-9c72-4c15-8c4b-e77f1db2d792`
- 8. Execute `7z x -oextracted section0.guid`
- 9. Open UEFITool and open the file `section0` in folder `extracted`
- 10. In a file manager, open `edk2-sdm845/sdm845Pkg/Binary`, duplicate `dipper` folder and rename it to your device's codename
- 11. In UEFITool, expand `UEFI image` and the volume underneath
- 12. For each file in your device's folder replace it with UEFITool by:
-	 - expanding the DXE Driver in UEFITool with the same name as the file you are replacing
-	 - in case of file that ends with `.depex` right clicking on DXE dependency
-	 - in case of file that ends with `.efi` right clicking on PE32 Image
-	 - clicking `Extract body`
-	 - deleting the original file
-	 - saving the one you are extracting and naming it same as the deleted one
-- In case a part (ex. DXE Dependency) is missing in UEFITool, just delete that file
- 13. Open `edk2-sdm845/sdm845Pkg` in a file manager
- 14. Duplicate `dipper.dsc` and `dipper.fdf` and rename both to your device's codename
- 15. Open the `.dsc` file, replace values 1080 and 2248 with your device's display width and height and save
- 16. Open the `.fdf` file, replace every word "dipper" with your device's codename and save
- 17. Open `edk2-sdm845` and edit `build.sh` with a text editor
- 18. Locate device list at the top, add your device's codename and save
-
- You can now build as usual.
- 
- Make sure to message the Discord or Telegram group in case you are stuck somewhere and if your port is successful, send `edk2-sdm845/sdm845Pkg/Binary/devicename` folder and `.dsc` and `.fdf` files.
+
+[edk2-sdm845 Porting Guide](https://renegade-doc.readthedocs.io/en/latest/edk2/port.html).
 
 ## License
 
diff --git a/README.zh.md b/README.zh.md
index b12fd6e..7ba0fed 100644
--- a/README.zh.md
+++ b/README.zh.md
@@ -4,9 +4,6 @@
 
 欢迎PR新设备的支持，以及设备树或ACPI的修复！
 
-![Github](https://img.shields.io/github/downloads/edk2-porting/edk2-sdm845/total)
-![Github](https://img.shields.io/github/v/release/edk2-porting/edk2-sdm845?include_prereleases)
-
 ## 资源
 
 [Telegram交流群](https://t.me/joinchat/MNjTmBqHIokjweeN0SpoyA)
@@ -15,39 +12,29 @@
 
 QQ交流群: 697666196
 
-## 开源许可证
-
-该项目在[WTFPL LICENSE](http://www.wtfpl.net/)下发布.
-
 ## 警告
 
 **请勿尝试移植到任何索尼设备上**
 
 **你的UFS会被清空!!!**
 
+## 已支持的设备
 
-**该项目仅支持骁龙845(sdm845)平台,不支持其它任何平台如骁龙855 (sm8150)**
-
-**请不要在非骁龙845设备上编译运行，如小米MIX3 5G**
+1. 小米MIX2S        (polaris)
+2. 小米MIX3         (perseus)
+3. 小米8            (dipper)
+4. 小米PocoPhone F1 (beryllium)
+5. 一加6            (enchilada)
+6. 一加6T           (fajita)
 
 ## 依赖
 
-Ubuntu 18.04:
+Ubuntu 20.04:
 
 ```bash
 sudo apt update
 sudo apt install build-essential uuid-dev iasl git nasm gcc-aarch64-linux-gnu abootimg python3-distutils python3-pil python3-git
 ```
-Ubuntu 20.04同上。
-
-## 已支持的设备
-
-1. 小米MIX2S        (polaris)
-2. 小米MIX3         (perseus)
-3. 小米8            (dipper)
-4. 小米PocoPhone F1 (beryllium)
-5. 一加6            (enchilada)
-6. 一加6T           (fajita)
 
 ## 构建
 
@@ -73,44 +60,12 @@ fastboot boot boot_DEVICE.img
 
 ## 贡献
 
-特别感谢[fxsheep](https://github.com/fxsheep)
-
-感谢[Lemon1Ice](https://github.com/Lemon1Ice)提供MemoryMap
-
-感谢[5超级菜鸟5](https://github.com/sunshuyu)以及其他人提供的ACPI
-
-SimpleFbDxe驱动来自imbushuo的[Lumia950XLPkg](https://github.com/WOA-Project/Lumia950XLPkg)
-
-同样感谢[tianocore wiki](https://github.com/tianocore/tianocore.github.io/wiki/Using-EDK-II-with-Native-GCC#Install_required_software_from_apt)
-
-## 简单的移植教程
-
- 1. 在终端执行`pip install --upgrade google-api-python-client uefi_firmware`以安装Python的模块protobuf和uefi_firmware-parser
- 2. 下载[extract_android_ota_payload](https://github.com/cyxx/extract_android_ota_payload/archive/master.zip)并将其解压到任何位置
- 3. 下载设备的OTA更新包
- 4. 解压payload.bin到`extract_android_ota_payload-master`文件夹
- 5. 在相同文件夹打开终端并执行并`python3 extract_android_ota_payload.py payload.bin`
- 6. 执行`uefi-firmware-parser -b -e xbl.img`
- 7. 进入文件夹`volume-******/file-9e21fd93-9c72-4c15-8c4b-e77f1db2d792`
- 8. 执行`7z x -oextracted section0.guid`
- 9. 打开UEFITool软件并打开`extracted`文件夹中的文件`section0`
- 10. 进入文件夹`edk2-sdm845/sdm845Pkg/Binary`,复制文件夹`dipper`并更名为你的设备代号
- 11. 在UEFITool中展开`UEFI image`在volume下操作
- 12. 在设备文件夹中对每个文件,请通过以下方式将使用UEFITool其替换为:
-	 - 用您要替换的文件相同的名称在UEFITool中展开DXE驱动程序
-	 - 如果文件以`.depex`结尾,请右键单击DXE依赖项
-	 - 如果文件以`.efi`结尾,请右键单击PE32镜像
-	 - 点击`Extract body`
-	 - 删除原始文件
-	 - 保存要提取的内容,并将其命名为已删除的内容
-- 如果UEFITool中缺少一部分(例如DXE依赖关系),只需删除该文件
- 13. 在文件管理器打开文件夹`edk2-sdm845/sdm845Pkg`
- 14. 复制`dipper.dsc`和`dipper.fdf`并更名为你的设备代号(`设备代号.dsc` `设备代号.fdf`)
- 15. 打开`设备代号.dsc`文件,使用你的设备的实际屏幕分辨率替换1080(宽)和2248(高)
- 16. 打开`设备代号.fdf`文件,将所有"dipper"替换成你的设备代号并保存
- 17. 进入文件夹`edk2-sdm845`并使用文本编辑器编辑`build.sh`
- 18. 在顶部的数组中添加你的设备代号并保存
-
- 然后现在可以编译并测试使用.
-
- 如果您在某个地方遇到问题,你可以在Discord、Telegram和QQ群中发送消息询问,并发送`edk2-sdm845/sdm845Pkg/Binary/设备代号`文件夹以及.dsc和.fdf文件。若移植成功，亦可发送消息告知。
+待填充
+
+## 简单的适配指南
+
+[edk2-sdm845适配指南](https://renegade-doc.readthedocs.io/zh_CN/latest/edk2/port.html).
+
+## 开源许可证
+
+该项目在[WTFPL LICENSE](http://www.wtfpl.net/)下发布.