!20 文档格式调整

Merge pull request !20 from woqidaideshi/master

documents/交叉编译内核.md

@@ -13,8 +13,6 @@
     - [创建编译内核模块目录](#创建编译内核模块目录)
     - [编译内核模块](#编译内核模块)
     - [收集编译结果](#收集编译结果)
-        - [内核](#内核)
-        - [设备树文件等](#设备树文件等)
 - [验证内核可用性](#验证内核可用性)
     - [将内核模块放进rootfs](#将内核模块放进rootfs)
     - [将内核放进引导](#将内核放进引导)
@@ -85,17 +83,17 @@
 
 ## 收集编译结果
 
-### 内核
+1.  内核
+    
+    `cp ${WORKDIR}/raspberrypi-kernel/arch/arm64/boot/Image ${WORKDIR}/output/`
 
-`cp ${WORKDIR}/raspberrypi-kernel/arch/arm64/boot/Image ${WORKDIR}/output/`
+2.  设备树文件等
 
-### 设备树文件等
+    `cp ${WORKDIR}/raspberrypi-kernel/arch/arm64/boot/dts/broadcom/*.dtb ${WORKDIR}/output/`
 
-`cp ${WORKDIR}/raspberrypi-kernel/arch/arm64/boot/dts/broadcom/*.dtb ${WORKDIR}/output/`
+    `mkdir ${WORKDIR}/output/overlays`
 
-`mkdir ${WORKDIR}/output/overlays`
-
-`cp ${WORKDIR}/raspberrypi-kernel/arch/arm64/boot/dts/overlays/*.dtb* ${WORKDIR}/output/overlays/`
+    `cp ${WORKDIR}/raspberrypi-kernel/arch/arm64/boot/dts/overlays/*.dtb* ${WORKDIR}/output/overlays/`
 
 至此，所有内核及内核模块相关内容都在 ${WORKDIR}/output 下了。
 

documents/刷写镜像.md

@@ -22,13 +22,11 @@
 
 - Windows10/Linux/Mac
 - 树莓派 3B/3B+/4B
-- 16G 以上的 Micro SD 卡
+- 8G 及以上的 Micro SD 卡
 
 # 获取树莓派 img 镜像
 
-下载适配树莓派的最新 openEuler 镜像，下面以 `XXX.img` 表示该镜像。
-
-注意！如果下载的是压缩后的镜像，需要先将压缩文件解压得到 img 格式的镜像文件。
+下载适配树莓派的最新 openEuler 镜像，下面以获取 `openEuler-20.03-LTS-aarch64-raspi.img.xz` 镜像为例。
 
 # 刷写 SD 卡
 
@@ -38,85 +36,95 @@
 
 ### 格式化 SD 卡
 
-下载应用：SDFormater，用于格式化 SD 卡。
-
-若 SD 卡之前未安装过镜像，盘符只有一个，SDFormater 应用中选择 SD 卡对应盘符，直接格式化即可；
+请按照以下步骤格式化 SD 卡：
 
-若 SD 卡之前安装过镜像，盘符会有多个，如下图所示，该 SD 卡对应三个盘符：E、G、H，SDFormater 应用中选择 SD 卡对应 boot 分区盘符 E，格式化即可。
+1.  下载并安装格式化 SD 卡工具，以下操作以 SD Card Formatter 格式化工具为例。
+2.  打开 SD Card Formatter，在 `Select card` 中选择需要格式化的 SD 卡的盘符。
 
-![](images/盘符.jpg)
+    若 SD 卡之前未安装过镜像，盘符只有一个。在 `Select card` 中选择需要格式化的 SD 卡对应盘符。
 
-![](images/格式化前.png)
+    若 SD 卡之前安装过镜像，盘符会有一个或多个。如下图所示，该 SD 卡对应三个盘符：E、G、H。在 `Select card` 中选择需要格式化的 SD 卡对应 boot 分区盘符 E。
 
-![](images/格式化后.png)
+    ![](images/盘符.jpg)
 
-![](images/格式化后盘.png)
+3.  在 `Formatting options` 中选择格式化方式。默认为 `Qick format`。
+4.  单击 `Format` 开始格式化。界面通过进度条显示格式化进度。
+5.  格式化完成后会弹出 `Formatting was successfully completed` 的提示框，单击 `确定` 完成格式化。
+    
+    如下图所示，格式化后 SD 卡的盘符只有一个。
+    
+    ![](images/格式化后盘.png)
 
 ### 写入 SD 卡
 
-下载应用：Win32 Disk Imager。
-
-右键选择“以管理员身份运行”，打开 Win32 Disk Imager，选择镜像 img 文件和待写入的 SD 卡，点击【写入/Write】。
+>![](public_sys-resources/icon-notice.gif) **须知：**   
+>如果获取的是压缩后的镜像文件 `openEuler-20.03-LTS-aarch64-raspi.img.xz`，需要先将压缩文件解压得到 `openEuler-20.03-LTS-aarch64-raspi.img` 镜像文件。
 
-![](images/写入SD.png)
+请按照以下步骤将 img 格式的镜像文件写入 SD 卡：
 
-写入完成即可。
+1.  下载并安装刷写镜像的工具，以下操作以 Win32 Disk Imager 工具为例。
+2.  右键选择“以管理员身份运行”，打开 Win32 Disk Imager。
+3.  选择镜像 img 文件。
+4.  选择待写入的 SD 卡盘符。
+5.  单击“写入”。如下图所示，界面通过任务进度条显示写入 SD 卡的进度。
+   
+    ![](images/写入SD.png)
 
-写入成功后，SD 卡自动分区后的盘符为三个，如下图所示。
-
-![](images/盘符.jpg)
+6.  写入完成后会弹出 “写入成功” 的提示框，单击“OK”完成写入。
+    
+    如下图所示，写入成功后，SD 卡自动分区后的盘符为三个。
+    
+    ![](images/盘符.jpg)
 
 ## Linux 环境
 
 ### 查看磁盘分区信息
 
-`fdisk -l`
-
-获取 SD 卡磁盘信息，例如 SD 卡对应磁盘为 /dev/sdb。
+执行 `fdisk -l` 获取 SD 卡磁盘信息，例如 SD 卡对应磁盘为 /dev/sdb。
 
 ### 卸载 SD 卡挂载点
 
-查看当前已挂在的卷
-
-`df -lh`
+1.  执行 `df -lh` 命令查看当前已挂载的卷。
+2.  如果 SD 卡对应的分区未挂载，则跳过该步骤；如果 SD 卡对应分区已挂载，如 SD 卡对应的两个分区 /dev/sdb1 和 /dev/sdb3 已挂载，则需要卸载对应分区，执行以下命令：
 
-如果 SD 卡对应的分区未挂载，则该步骤跳过；如果 SD 卡对应分区已挂载，如 SD 卡对应的两个分区 /dev/sdb1 和 /dev/sdb3 已挂载，则需要卸载对应分区：
+    `umount /dev/sdb1`
 
-`umount /dev/sdb1`
-
-`umount /dev/sdb3`
+    `umount /dev/sdb3`
 
 ### 写入 SD 卡
 
-将下载的镜像 `XXX.img` 刷入 SD 卡。
+1.  如果获取的是压缩后的镜像，需要先执行 `xz -d openEuler-20.03-LTS-aarch64-raspi.img.xz` 命令将压缩文件解压得到 `openEuler-20.03-LTS-aarch64-raspi.img` 镜像文件；否则，跳过该步骤。
+2.  将镜像 `openEuler-20.03-LTS-aarch64-raspi.img` 刷写入 SD 卡，执行以下命令：
+    
+    `dd bs=4M if=openEuler-20.03-LTS-aarch64-raspi.img of=/dev/sdb`
 
-`dd bs=4M if=XXX.img of=/dev/sdb`
+    >![](public_sys-resources/icon-note.gif) **说明：** 
+    >一般情况下，将块大小设置为 4M。如果写入失败或者写入的镜像无法使用，可以尝试将块大小设置为 1M 重新写入，但是设置为 1M 比较耗时。
 
 ## Mac 环境
 
 ### 查看磁盘分区信息
 
-`diskutil list`
-
-获取 SD 卡磁盘信息，例如 SD 卡对应磁盘为 /dev/disk3。
+执行 `diskutil list` 获取 SD 卡磁盘信息，例如 SD 卡对应磁盘为 /dev/disk3。
 
 ### 卸载 SD 卡挂载点
 
-查看当前已挂在的卷
-
-`df -lh`
+1.  执行 `df -lh` 命令查看当前已挂载的卷。
+2.  如果 SD 卡对应的分区未挂载，则跳过该步骤；如果 SD 卡对应分区已挂载，如 SD 卡对应的两个分区 /dev/disk3s1 和 /dev/disk3s3 已挂载，则需要卸载对应分区，执行以下命令：
 
-如果 SD 卡对应的分区未挂载，则该步骤跳过；如果 SD 卡对应分区已挂载，如 SD 卡对应的两个分区 /dev/sdb1 和 /dev/sdb3 已挂载，则需要卸载对应分区：
+    `diskutil umount /dev/disk3s1`
 
-`diskutil umount /dev/sdb1`
-
-`diskutil umount /dev/sdb3`
+    `diskutil umount /dev/disk3s3`
 
 ### 写入 SD 卡
 
-将下载的镜像 `XXX.img` 刷入 SD 卡。
+1.  如果获取的是压缩后的镜像，需要先执行 `xz -d openEuler-20.03-LTS-aarch64-raspi.img.xz` 命令将压缩文件解压得到 `openEuler-20.03-LTS-aarch64-raspi.img` 镜像文件；否则，跳过该步骤。
+2.  将镜像 `openEuler-20.03-LTS-aarch64-raspi.img` 刷入 SD 卡，执行以下命令：
+
+    `dd bs=4m if=openEuler-20.03-LTS-aarch64-raspi.img of=/dev/sdb`
 
-`dd bs=4m if=XXX.img of=/dev/sdb`
+    >![](public_sys-resources/icon-note.gif) **说明：** 
+    >一般情况下，将块大小设置为 4m。如果写入失败或者写入的镜像无法使用，可以尝试将块大小设置为 1m 重新写入，但是设置为 1m 比较耗时。
 
 # 树莓派使用
 

scripts/config/openEuler-20.03-LTS.repo

-[openEuler]
-name=openEuler 20.03 LTS
-baseurl=http://repo.openeuler.org/openEuler-20.03-LTS/OS/aarch64/
+#generic-repos is licensed under the Mulan PSL v2.
+#You can use this software according to the terms and conditions of the Mulan PSL v2.
+#You may obtain a copy of Mulan PSL v2 at:
+#    http://license.coscl.org.cn/MulanPSL2
+#THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR
+#IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR
+#PURPOSE.
+#See the Mulan PSL v2 for more details.
+
+[OS]
+name=OS
+baseurl=http://repo.openeuler.org/openEuler-20.03-LTS/OS/$basearch/
 enabled=1
-gpgcheck=0
+gpgcheck=1
+gpgkey=http://repo.openeuler.org/openEuler-20.03-LTS/OS/$basearch/RPM-GPG-KEY-openEuler
 
-[openEuler-source]
-name=openEuler 20.03 LTS - Source
-baseurl=http://repo.openeuler.org/openEuler-20.03-LTS/source/
+[everything]
+name=everything
+baseurl=http://repo.openeuler.org/openEuler-20.03-LTS/everything/$basearch/
+enabled=1
+gpgcheck=1
+gpgkey=http://repo.openeuler.org/openEuler-20.03-LTS/everything/$basearch/RPM-GPG-KEY-openEuler
+
+[EPOL]
+name=EPOL
+baseurl=http://repo.openeuler.org/openEuler-20.03-LTS/EPOL/$basearch/
 enabled=1
-gpgcheck=0
+gpgcheck=1
+gpgkey=http://repo.openeuler.org/openEuler-20.03-LTS/OS/$basearch/RPM-GPG-KEY-openEuler
 
-[openEuler-everything]
-name=openEuler 20.03 LTS - Everything
-baseurl=http://repo.openeuler.org/openEuler-20.03-LTS/everything/aarch64/
+[debuginfo]
+name=debuginfo
+baseurl=http://repo.openeuler.org/openEuler-20.03-LTS/debuginfo/$basearch/
 enabled=1
-gpgcheck=0
\ No newline at end of file
+gpgcheck=1
+gpgkey=http://repo.openeuler.org/openEuler-20.03-LTS/debuginfo/$basearch/RPM-GPG-KEY-openEuler
+
+[source]
+name=source
+baseurl=http://repo.openeuler.org/openEuler-20.03-LTS/source/
+enabled=1
+gpgcheck=1
+gpgkey=http://repo.openeuler.org/openEuler-20.03-LTS/source/RPM-GPG-KEY-openEuler
+
+[update]
+name=update
+baseurl=http://repo.openeuler.org/openEuler-20.03-LTS/update/$basearch/
+enabled=0
+gpgcheck=1
+gpgkey=http://repo.openeuler.org/openEuler-20.03-LTS/OS/$basearch/RPM-GPG-KEY-openEuler