Simplify and update README
authorXilin Wu <strongtz@yeah.net>
星期三, 30 Jun 2021 11:30:38 +0000 (19:30 +0800)
committerBigfootACA <bigfoot@classfun.cn>
星期五, 2 Jul 2021 08:30:14 +0000 (16:30 +0800)
Signed-off-by: Xilin Wu <strongtz@yeah.net>
README.md
README.zh.md

index 8013de81498e2df532b7a139bea9315c0801f860..5834dcfc9eb0ddedfa3f5402a4d54271cf7324ca 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 ![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)
 
-A broken but working EDK2 implementation for Snapdragon 845 platform.
+EDK2 implementation for Snapdragon 845 platform.
 
 [Chinese version (中文版)](https://github.com/edk2-porting/edk2-sdm845/blob/master/README.zh.md)
 
@@ -13,36 +13,34 @@ A broken but working EDK2 implementation for Snapdragon 845 platform.
 
 [Discord group](https://discord.gg/XXBWfag)
 
-QQ group: 697666196 (Main group)
-
-QQ group: 737223105 (Linux/edk2)
+QQ group: 697666196 (Main group)    737223105 (Linux/edk2)
 
 [Windows Drivers](https://github.com/edk2-porting/WOA-Drivers)
 
-[Useless documents](https://renegade-doc.readthedocs.io/en/latest/index.html)
+[Project website](https://renegade-project.org/))
 
 ## WARNING
 
-**DO NOT EVER TRY TO PORT IT TO *SONY* DEVICES**
+**DO NOT EVER TRY TO PORT IT TO *SONY* and *GOOGLE* DEVICES**
 
 **YOUR UFS WILL BE WIPED CLEAN!!!**
 
 ## Supported devices
 
-1. Xiaomi MIX 2S       (polaris)
-2. Xiaomi MIX 3        (perseus)
-3. Xiaomi MI 8         (dipper)
+1. OnePlus 6           (enchilada)
+2. OnePlus 6T          (fajita)
+3. Xiaomi MIX 3        (perseus)
 4. Xiaomi PocoPhone F1 (beryllium)
-5. OnePlus 6           (enchilada)
-6. OnePlus 6T          (fajita)
-7. Nubia X             (nx616j)
-8. Meizu 16th          (m1882)
-9. BlackShark One      (skr-a0)
-10. LG G7              (judyln)         (Will automatically restart)
-11. Samsung Galaxy S9+ (star2qltechn)   (May wipe your UFS)
+5. Meizu 16th          (m1882)
+6. Smartisan R1       (trident)
+7. BlackShark One      (skr-a0)
+8. OPPO Find X        (pafm00)
+9. Xiaomi MIX 2S       (polaris)
+10. LG G7              (judyln)
+11. Samsung Galaxy S9+ (star2qltechn)
 12. Xiaomi MI 7        (dipper-old)
-13. OPPO Find X        (pafm00)
-14. Smartisan R1       (trident)
+13. Xiaomi MI 8         (dipper)
+14. Nubia X             (nx616j)
 15. Nokia9 PureView    (olympic)
 
 ## Dependencies
@@ -57,7 +55,7 @@ sudo apt install build-essential uuid-dev iasl git nasm gcc-aarch64-linux-gnu ab
 
 ## Building
 
-1.Clone this project (no need for recursive)
+1.Clone this project
 
 ```bash
 git clone https://github.com/edk2-porting/edk2-sdm845.git --depth=1
@@ -86,21 +84,17 @@ fastboot flash recovery boot_DEVICE.img
 
 ## Credits
 
-@fxsheep for his original `edk2-sagit`
-
-@strongtz for the creating and maintaining the whole Renegade Project
-
-@BigfootACA for build script
+`fxsheep` for his original `edk2-sagit`
 
-@lemon1ice and NTAuthority for guidance and some blobs
+`strongtz` for maintaining Renegade Project
 
-@wetdreams and TAOCroatia for working hard on testing and debugging
+`BigfootACA` for build script
 
-@NekokeCore for fixing MemoryMap
+`Lemon_Ice` and `NTAuthority` for guidance and some blobs
 
-## Porting Guide
+`@Freak2112`, `TAO_Croatia` and `废物` for working hard on testing and debugging
 
-[edk2-sdm845 Porting Guide](https://renegade-doc.readthedocs.io/en/latest/edk2/port.html).
+`NekokeCore` for fixing MemoryMap
 
 ## License
 
index 6d087b87f6cd8076aab5ea1ec22e361162119981..b48b8d649aca199f3fc0cfcda5bd48bb8df6abd6 100644 (file)
@@ -3,9 +3,7 @@
 ![Github](https://img.shields.io/github/downloads/edk2-porting/edk2-sdm845/total)\r
 ![Github](https://img.shields.io/github/v/release/edk2-porting/edk2-sdm845?include_prereleases)\r
 \r
-**在编译该项目前,请确定你有一定的Linux常识,以下步骤已经是最简单的方法,如果你看不懂,那么请离开**\r
-\r
-一个针对骁龙845平台的勉强能用的EDK2 UEFI\r
+**在编译该项目前,请确定你有一定的Linux常识,以下步骤已经是最简单的方法,如果你看不懂,那么请使用Releases中的编译成品**\r
 \r
 ## 资源\r
 \r
 \r
 [Discord交流群](https://discord.gg/XXBWfag)\r
 \r
-QQ交流群: 697666196 (主群)\r
-\r
-QQ交流群: 737223105 (Linux/edk2)\r
+QQ交流群: 697666196 (主群)      737223105 (Linux/edk2)\r
 \r
 [Windows 驱动](https://github.com/edk2-porting/WOA-Drivers)\r
 \r
-[没什么用的文档](https://renegade-doc.readthedocs.io/zh_CN/latest/index.html)\r
+[项目官网](https://renegade-project.org/)\r
 \r
 ## 警告\r
 \r
@@ -29,22 +25,20 @@ QQ交流群: 737223105 (Linux/edk2)
 \r
 ## 已支持的设备\r
 \r
-此列表为能够启动进入UEFI Shell的设备\r
-\r
-1. 小米MIX2S        (polaris)\r
-2. 小米MIX3         (perseus)\r
-3. 小米8            (dipper)\r
+1. 一加6            (enchilada)\r
+2. 一加6T           (fajita)\r
+3. 小米MIX3         (perseus)\r
 4. 小米PocoPhone F1 (beryllium)\r
-5. 一加6            (enchilada)\r
-6. 一加6T           (fajita)\r
-7. 努比亚X          (nx616j)\r
-8. 魅族16th         (m1882)\r
-9. 黑鲨手机一代     (skr-a0)\r
-10. LG G7           (judyln)            (会自动重启)\r
-11. 三星S9+         (star2qltechn)      (有可能会清空UFS)\r
-12. 小米7           (dipper-old)\r
-13. OPPO Find X     (pafm00)\r
-14. 锤子坚果R1      (trident)\r
+5. 魅族16th         (m1882)\r
+6. 锤子坚果R1       (trident)\r
+7. 黑鲨手机一代      (skr-a0)\r
+8. OPPO Find X      (pafm00)\r
+9. 小米MIX2S        (polaris)\r
+10. LG G7           (judyln)\r
+11. 三星S9+         (star2qltechn)\r
+12. 小米7(工程机)  (dipper-old)\r
+13. 小米8           (dipper)\r
+14. 努比亚X         (nx616j)\r
 15. 诺基亚9 PureView(olympic)\r
 \r
 ## 依赖\r
@@ -57,10 +51,6 @@ sudo apt upgrade
 sudo apt install build-essential uuid-dev iasl git nasm gcc-aarch64-linux-gnu abootimg python3-distutils python3-pil python3-git\r
 ```\r
 \r
-## 视频教程\r
-\r
-[【UEFI】edk2-sdm845项目编译教程 - 5超级菜鸟5](https://www.bilibili.com/video/BV1ab4y197e7)\r
-\r
 ## 构建\r
 \r
 **不建议使用Ubuntu 18.04版本,请使用Ubuntu 20.04或以上版本**\r
@@ -94,11 +84,17 @@ fastboot flash recovery boot_DEVICE.img
 \r
 ## 贡献\r
 \r
-待填充\r
+感谢`fxsheep`的`edk2-sagit`\r
+\r
+感谢`strongtz`维护Renegade Project\r
+\r
+感谢`BigfootACA`的编译脚本\r
+\r
+感谢`Lemon_Ice`和`NTAuthority`提供指导以及一些有用的blob\r
 \r
-## 简单的适配指南\r
+感谢`@Freak2112`, `TAO_Croatia`和`废物`的实机调试\r
 \r
-[edk2-sdm845适配指南](https://renegade-doc.readthedocs.io/zh_CN/latest/edk2/port.html).\r
+感谢`NekokeCore`参与了MemoryMap的修复\r
 \r
 ## 开源许可证\r
 \r