Merge pull request #41 from weilinfox/main

提交 0.7.0 新增特性
ruyisdk · Apr 9, 2024 · 4232a98 · 4232a98
2 parents fd97547 + f5caac6
commit 4232a98
Show file tree

Hide file tree

Showing 8 changed files with 111 additions and 19 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -58,7 +58,8 @@ export default defineConfig({
                       { text: 'v0.3.0 版本新增特性', link: '/zh/ruyi/updates/0.3.0' },
                       { text: 'v0.4.0 版本新增特性', link: '/zh/ruyi/updates/0.4.0' },
                       { text: 'v0.5.0 版本新增特性', link: '/zh/ruyi/updates/0.5.0' },
-                      { text: 'v0.6.0 版本新增特性', link: '/zh/ruyi/updates/0.6.0' }
+                      { text: 'v0.6.0 版本新增特性', link: '/zh/ruyi/updates/0.6.0' },
+                      { text: 'v0.7.0 版本新增特性', link: '/zh/ruyi/updates/0.7.0' }
                     ]
                   }
                 ]

diff --git a/docs/zh/ruyi/getstarted/index.md b/docs/zh/ruyi/getstarted/index.md
@@ -20,12 +20,12 @@ $ sudo apt-get install wget git tar bzip2 xz zstd
 
 ## 安装 RUYI 包管理器
 
-从 [GitHub Releases](https://github.com/RuyiSDK/ruyi/releases/) 或 [ISCAS 镜像源](https://mirror.iscas.ac.cn/RuyiSDK/ruyi/releases)下载最新版本，选择合适架构的预编译二进制下载，当前 RUYI 包管理支持 amd64 、arm64、 riscv64 架构编译环境。
+从 [GitHub Releases](https://github.com/ruyisdk/ruyi/releases/) 或 [ISCAS 镜像源](https://mirror.iscas.ac.cn/ruyisdk/ruyi/releases)下载最新版本，选择合适架构的预编译二进制下载，当前 RUYI 包管理支持 amd64 、arm64、 riscv64 架构编译环境。
 
 这里以 amd64 架构环境为例进行安装：
 
 ```bash
-$ wget https://mirror.iscas.ac.cn/RuyiSDK/ruyi/testing/ruyi.amd64.20231211
+$ wget https://mirror.iscas.ac.cn/ruyisdk/ruyi/testing/ruyi.amd64.20231211
 $ chmod +x ./ruyi.amd64.20231211
 $ sudo cp ruyi.amd64.20231211 /usr/local/bin/ruyi
 $ ruyi version
@@ -94,7 +94,7 @@ $ ruyi news read --quiet  	# 不输出任何东西，只标记为已读
 $ ruyi list
 List of available packages:
 
-* source/RuyiSDK-demo
+* source/ruyisdk-demo
   - 0.20231114.0 (latest)
 * source/coremark
   - 1.0.2-pre.20230125 (prerelease, latest-prerelease)
@@ -168,7 +168,7 @@ $ ruyi install --reinstall gnu-upstream
 RUYI 包管理器同时管理一些源码包，使用 ``extract`` 命令下载一个源码包并解包到当前目录：
 
 ```bash
-$ ruyi extract RuyiSDK-demo
+$ ruyi extract ruyisdk-demo
 $ ls
 README.md  rvv-autovec
 ```

diff --git a/docs/zh/ruyi/updates/0.3.0.md b/docs/zh/ruyi/updates/0.3.0.md
@@ -14,15 +14,15 @@ v0.3.0 版本的稳定二进制为 0.3.0 。
 在 amd64 架构环境安装：
 
 ```bash
-$ wget https://mirror.iscas.ac.cn/RuyiSDK/ruyi/releases/0.3.0/ruyi.amd64
+$ wget https://mirror.iscas.ac.cn/ruyisdk/ruyi/releases/0.3.0/ruyi.amd64
 $ chmod +x ./ruyi.amd64
 $ sudo cp ./ruyi.amd64 /usr/local/bin/ruyi
 ```
 
 在 riscv64 架构环境安装：
 
 ```bash
-$ wget https://mirror.iscas.ac.cn/RuyiSDK/ruyi/releases/0.3.0/ruyi.riscv64
+$ wget https://mirror.iscas.ac.cn/ruyisdk/ruyi/releases/0.3.0/ruyi.riscv64
 $ chmod +x ./ruyi.riscv64
 $ sudo cp ./ruyi.riscv64 /usr/local/bin/ruyi
 ```

diff --git a/docs/zh/ruyi/updates/0.4.0.md b/docs/zh/ruyi/updates/0.4.0.md
@@ -12,15 +12,15 @@ v0.4.0 版本的稳定二进制为 0.4.0 。
 在 amd64 架构环境安装：
 
 ```bash
-$ wget https://mirror.iscas.ac.cn/RuyiSDK/ruyi/releases/0.4.0/ruyi.amd64
+$ wget https://mirror.iscas.ac.cn/ruyisdk/ruyi/releases/0.4.0/ruyi.amd64
 $ chmod +x ./ruyi.amd64
 $ sudo cp ./ruyi.amd64 /usr/local/bin/ruyi
 ```
 
 在 riscv64 架构环境安装：
 
 ```bash
-$ wget https://mirror.iscas.ac.cn/RuyiSDK/ruyi/releases/0.4.0/ruyi.riscv64
+$ wget https://mirror.iscas.ac.cn/ruyisdk/ruyi/releases/0.4.0/ruyi.riscv64
 $ chmod +x ./ruyi.riscv64
 $ sudo cp ./ruyi.riscv64 /usr/local/bin/ruyi
 ```

diff --git a/docs/zh/ruyi/updates/0.5.0.md b/docs/zh/ruyi/updates/0.5.0.md
@@ -10,15 +10,15 @@ v0.5.0 版本的稳定二进制为 0.5.0 。
 在 amd64 架构环境安装：
 
 ```bash
-$ wget https://mirror.iscas.ac.cn/RuyiSDK/ruyi/releases/0.5.0/ruyi.amd64
+$ wget https://mirror.iscas.ac.cn/ruyisdk/ruyi/releases/0.5.0/ruyi.amd64
 $ chmod +x ./ruyi.amd64
 $ sudo cp ./ruyi.amd64 /usr/local/bin/ruyi
 ```
 
 在 riscv64 架构环境安装：
 
 ```bash
-$ wget https://mirror.iscas.ac.cn/RuyiSDK/ruyi/releases/0.5.0/ruyi.riscv64
+$ wget https://mirror.iscas.ac.cn/ruyisdk/ruyi/releases/0.5.0/ruyi.riscv64
 $ chmod +x ./ruyi.riscv64
 $ sudo cp ./ruyi.riscv64 /usr/local/bin/ruyi
 ```

diff --git a/docs/zh/ruyi/updates/0.6.0.md b/docs/zh/ruyi/updates/0.6.0.md
@@ -8,18 +8,12 @@
 在 amd64 架构环境安装：
 
 ```bash
-$ wget https://mirror.iscas.ac.cn/RuyiSDK/ruyi/releases/0.6.0/ruyi.amd64
+$ wget https://mirror.iscas.ac.cn/ruyisdk/ruyi/releases/0.6.0/ruyi.amd64
 $ chmod +x ./ruyi.amd64
 $ sudo cp ./ruyi.amd64 /usr/local/bin/ruyi
 ```
 
-在 riscv64 架构环境安装：
-
-```bash
-$ wget https://mirror.iscas.ac.cn/RuyiSDK/ruyi/releases/0.6.0/ruyi.riscv64
-$ chmod +x ./ruyi.riscv64
-$ sudo cp ./ruyi.riscv64 /usr/local/bin/ruyi
-```
+注意 v0.6.0 版本的 riscv64 二进制可能无法正常工作，请使用更新的版本。
 
 检查安装版本：
 

diff --git a/docs/zh/ruyi/updates/0.7.0.md b/docs/zh/ruyi/updates/0.7.0.md
@@ -0,0 +1,93 @@
+# v0.7.0 版本新增特性
+
++ 板卡镜像刷写支持增加到 13 款
++ 修复 v0.6.0 版本 riscv64 二进制无法工作的问题
+
+## 安装 v0.7.0
+
+在 amd64 架构环境安装：
+
+```bash
+$ wget https://mirror.iscas.ac.cn/ruyisdk/ruyi/releases/0.7.0/ruyi.amd64
+$ chmod +x ./ruyi.amd64
+$ sudo cp ./ruyi.amd64 /usr/local/bin/ruyi
+```
+
+在 riscv64 架构环境安装：
+
+```bash
+$ wget https://mirror.iscas.ac.cn/ruyisdk/ruyi/releases/0.7.0/ruyi.riscv64
+$ chmod +x ./ruyi.riscv64
+$ sudo cp ./ruyi.riscv64 /usr/local/bin/ruyi
+```
+
+在 arm64 架构环境安装：
+
+```bash
+$ wget https://mirror.iscas.ac.cn/ruyisdk/ruyi/releases/0.7.0/ruyi.arm64
+$ chmod +x ./ruyi.arm64
+$ sudo cp ./ruyi.arm64 /usr/local/bin/ruyi
+```
+
+检查安装版本：
+
+```bash
+$ ruyi version
+Ruyi 0.7.0
+Copyright (C) 2023 Institute of Software, Chinese Academy of Sciences (ISCAS).
+All rights reserved.
+License: Apache-2.0 <https://www.apache.org/licenses/LICENSE-2.0>
+```
+
+## 板卡镜像刷写
+
+在 0.7.0 版本，板卡镜像刷写功能所支持的板卡增加到 13 款。
+
+注意 Milkv-V Vega 暂时没有提供官方镜像下载，故此处只提供了文档链接而没有刷写支持。
+
+板卡支持列表：
+
+| 开发板 | 版本 | 镜像 | 刷写方式 |
+|:-:|:-:|:-:|:-:|
+| Allwinner Nezha D1 | Allwinner Nezha D1 (generic variant) | openEuler RISC-V (base system) for Allwinner D1 | dd |
+|  |  | openEuler RISC-V (XFCE) for Allwinner D1 | dd |
+| Canaan Kendryte K230 | Canaan Kendryte K230 (generic variant) | Canaan Kendryte K230 Official CanMV Debian SDK | dd |
+|  |  | Canaan Kendryte K230 Official CanMV Ubuntu SDK | dd |
+| Milk-V Duo | Milk-V Duo (64M RAM) | Milk-V Duo Official buildroot SDK (64M RAM) | dd |
+|  |  | Milk-V Duo Official buildroot SDK (64M RAM, with Python) | dd |
+|  | Milk-V Duo (256M RAM) | Milk-V Duo Official buildroot SDK (256M RAM) | dd |
+|  |  | Milk-V Duo Official buildroot SDK (256M RAM, with Python) | dd |
+| Milk-V Duo S | Milk-V Duo S (generic variant) | Milk-V Duo S Official buildroot SDK (FreeRTOS, on SD card) | dd |
+| Milk-V Mars | Milk-V Mars (generic variant) | Milk-V Mars Official Debian Desktop SDK (on SD card) | dd |
+| Milk-V Mars CM | Milk-V Mars CM (generic variant) | Milk-V Mars CM Official Debian Desktop SDK (on SD card) | dd |
+| Milk-V Vega | Milk-V Vega (generic variant) | Milk-V Vega Official Buildroot SDK (documentation-only) |  |
+| Milk-V Pioneer Box | Milk-V Pioneer Box (v1.3) | openEuler RISC-V (base system) for Milk-V Pioneer (rootfs on NVMe) | dd |
+|  |  | openEuler RISC-V (XFCE) for Milk-V Pioneer (rootfs on NVMe) | dd |
+|  |  | RevyOS for Milk-V Pioneer | dd |
+|  | Milk-V Pioneer Box (v1.2) | openEuler RISC-V (base system) for Milk-V Pioneer (rootfs on NVMe) | dd |
+|  |  | openEuler RISC-V (XFCE) for Milk-V Pioneer (rootfs on NVMe) | dd |
+|  | Milk-V Pioneer Box (v1.1) | openEuler RISC-V (base system) for Milk-V Pioneer (rootfs on NVMe) | dd |
+|  |  | openEuler RISC-V (XFCE) for Milk-V Pioneer (rootfs on NVMe) | dd |
+| SiFive HiFive Unmatched | SiFive HiFive Unmatched (generic variant) | openEuler RISC-V (base system) for SiFive HiFive Unmatched | dd |
+|  |  | openKylin for SiFive HiFive Unmatched | dd |
+|  |  | openEuler RISC-V (XFCE) for SiFive HiFive Unmatched | dd |
+|  |  | OpenWrt for SiFive HiFive Unmatched | dd |
+|  |  | Ubuntu Server for SiFive HiFive Unmatched | dd |
+| Sipeed Lichee RV | Sipeed Lichee RV (generic variant) | openEuler RISC-V (base system) for Allwinner D1 | dd |
+|  |  | openEuler RISC-V (XFCE) for Allwinner D1 | dd |
+| Sipeed LicheePi 4A | Sipeed LicheePi 4A (8G RAM) | openEuler RISC-V (headless) for Sipeed LicheePi 4A (8G RAM) | fastboot |
+|  |  | openEuler RISC-V (XFCE) for Sipeed LicheePi 4A (8G RAM) | fastboot |
+|  |  | RevyOS for Sipeed LicheePi 4A (8G RAM) | fastboot |
+|  | Sipeed LicheePi 4A (16G RAM) | openEuler RISC-V (headless) for Sipeed LicheePi 4A (16G RAM) | fastboot |
+|  |  | openEuler RISC-V (XFCE) for Sipeed LicheePi 4A (16G RAM) | fastboot |
+|  |  | RevyOS for Sipeed LicheePi 4A (16G RAM) | fastboot |
+| StarFive VisionFive | StarFive VisionFive (generic variant) | openEuler RISC-V (base system) for StarFive VisionFive | dd |
+|  |  | openEuler RISC-V (XFCE) for StarFive VisionFive | dd |
+| StarFive VisionFive2 | StarFive VisionFive2 (generic variant) | openEuler RISC-V (base system) for StarFive VisionFive2 | dd |
+|  |  | openEuler RISC-V (XFCE) for StarFive VisionFive2 | dd |
+
+刷写工具根据板卡的不同依赖 ``dd`` 和 ``fastboot`` 命令， RUYI 将自动调用 ``sudo`` 提权。
+
+需要注意的是一些镜像的解包需要占用大量的磁盘空间，使用 RUYI 工具刷写镜像前请务必留足磁盘空间；
+一些厂家提供的镜像在刷写后并不会自动扩展分区来充分利用整块磁盘，而需要用户自行扩展磁盘分区大小。
+
diff --git a/docs/zh/usedirection/developmentside/environments/index.md b/docs/zh/usedirection/developmentside/environments/index.md
@@ -23,6 +23,7 @@ RUYI 包管理在建立编译环境之前会检查该环境是否合法，但是
 |      gnu-upstream      |     自带     |       generic       |
 |        gnu-plct        |     自带     |       generic       |
 |        gnu-plct        |     自带     |      milkv-duo      |
+|        gnu-plct        |     自带     |   xiangshan-nanhu   |
 |    gnu-plct-xthead    |     自带     |    sipeed-lpi4a    |
 | gnu-plct-rv64ilp32-elf |      无      | baremetal-rv64ilp32 |
 |     llvm-upstream     | gnu-upstream |       generic       |
@@ -65,6 +66,9 @@ $ ruyi venv -t gnu-upstream generic ./generic-venv
 # 使用 PLCT 工具链配置 Milkv-Duo 编译环境：
 $ ruyi venv -t gnu-plct milkv-duo ./milkv-venv
 
+# 使用 PLCT 工具链配置香山南湖编译环境：
+$ ruyi venv -t gnu-plct xiangshan-nanhu ./nanhu-venv
+
 # 使用 LLVM 上游工具链配置 RISC-V 编译环境：
 $ ruyi venv -t llvm-upstream --sysroot-from gnu-upstream generic ./llvm-venv