diff --git a/README.en.md b/README.en.md index 97074dba00bfb174fc329a6910aaa9b5596931b7..25139402202cc3094d805953dbda8185e5af70cf 100644 --- a/README.en.md +++ b/README.en.md @@ -2,7 +2,24 @@ English | [简体中文](./README.md) -This repository is main repository of openEuler RaspberryPi SIG, and provides scripts for building openEuler image for Raspberry Pi and related documents: +This repository is main repository of openEuler RaspberryPi SIG, and provides scripts for building openEuler image for Raspberry Pi and related documents. + + + +- [raspberrypi](#raspberrypi) + - [How to collaborate](#how-to-collaborate) + - [File description](#file-description) + - [How to download latest image](#how-to-download-latest-image) + - [How to Use image](#how-to-use-image) + - [How to build image locally](#how-to-build-image-locally) + - [Prepare the environment](#prepare-the-environment) + - [Run the scripts to build image](#run-the-scripts-to-build-image) + - [Quickly Build without kernel compilation(Recommended)](#quickly-build-without-kernel-compilationrecommended) + - [Build with kernel compilation](#build-with-kernel-compilation) + - [Build on host](#build-on-host) + - [Build in a Docker container](#build-in-a-docker-container) + + ## How to collaborate @@ -20,17 +37,17 @@ You can get introduction of openEuler RaspberryPi SIG from [sig-RaspberryPi](htt - [Meeting Minutes](https://gitee.com/openeuler/raspberrypi/issues/I1EYZ6) - Warmly welcome to sumbit Pull Requests. -## Files and Directories +## File description + +>![](documents/public_sys-resources/icon-note.gif) **NOTE: ** +>- Recommendation: use the openEuler-RaspberryPi images provided in the chapter [How to download latest image](#how-to-download-latest-image) of this documentation. +>- If you need to customize the image, please refer to [Building openEuler image for Raspberry Pi](documents/openEuler镜像的构建.md) and [Cross-compile the kernel](documents/交叉编译内核.md). -- [scripts](./scripts): Script for building openEuler image for Raspberry Pi - - [Quickly Build (without kernel compilation)](scripts/build-image.sh) - - [Build on host (with kernel compilation)](scripts/build-image-common.sh) - - [Build in a Docker container (with kernel compilation)](scripts/build-image-docker.sh) - [documents](./documents/): - - [Building openEuler image for Raspberry Pi](documents/openEuler镜像的构建.md) - - [Cross-compile the kernel](documents/交叉编译内核.md) - [Install openEuler on a SD card](documents/刷写镜像.md) - [How to use Raspberry Pi](documents/树莓派使用.md) + - [Building openEuler image for Raspberry Pi](documents/openEuler镜像的构建.md) + - [Cross-compile the kernel](documents/交叉编译内核.md) - [openEuler 20.03 LTS alpha version ChangeLog](documents/changelog/changelog-20.03-LTS.en.md) - [openEuler 20.09 alpha version ChangeLog](documents/changelog/changelog-20.09.en.md) - [openEuler 20.09 alpha version (with Xfce desktop environment) ChangeLog](documents/changelog/changelog-20.09-Xfce.en.md) @@ -39,6 +56,10 @@ You can get introduction of openEuler RaspberryPi SIG from [sig-RaspberryPi](htt - [openEuler 20.03 LTS SP1 alpha version (with UKUI desktop environment) ChangeLog](documents/changelog/changelog-20.03-LTS-SP1-UKUI.en.md) - [openEuler 20.03 LTS SP1 alpha version (with DDE desktop environment) ChangeLog](documents/changelog/changelog-20.03-LTS-SP1-DDE.en.md) - [openEuler 20.03 LTS SP1 ChangeLog](documents/changelog/changelog-20.03-LTS-SP1-release.en.md) +- [scripts](./scripts): Script for building openEuler image for Raspberry Pi + - [Quickly Build (without kernel compilation)](scripts/build-image.sh) + - [Build on host (with kernel compilation)](scripts/build-image-common.sh) + - [Build in a Docker container (with kernel compilation)](scripts/build-image-docker.sh) ## How to download latest image diff --git a/README.md b/README.md index f2078a9e6c2aa82ce71749cfb237f5a108770a2a..1cb95bd25ca9ae96179c5203ea40fd5422c95588 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,24 @@ [English](./README.en.md) | 简体中文 -本仓库是 openEuler 社区树莓派 SIG 组的主仓库，提供 SIG 组相关信息以及适用于树莓派的 openEuler 镜像的构建脚本和相关文档： +本仓库是 openEuler 社区树莓派 SIG 组的主仓库，提供 SIG 组相关信息以及适用于树莓派的 openEuler 镜像的构建脚本和相关文档。 + + + +- [raspberrypi](#raspberrypi) + - [如何参与 SIG 组](#如何参与-sig-组) + - [文件说明](#文件说明) + - [最新镜像](#最新镜像) + - [使用镜像](#使用镜像) + - [镜像构建](#镜像构建) + - [准备环境](#准备环境) + - [构建镜像](#构建镜像) + - [快速构建（无需编译内核，推荐）](#快速构建无需编译内核推荐) + - [完全构建（包括编译内核）](#完全构建包括编译内核) + - [主机上构建](#主机上构建) + - [Docker 容器内构建](#docker-容器内构建) + + ## 如何参与 SIG 组 @@ -19,17 +36,17 @@ SIG 组基本信息位于 [sig-RaspberryPi](https://gitee.com/jianminw/community - [会议记录](https://gitee.com/openeuler/raspberrypi/issues/I1EYZ6)：每次会议结束后会议结论会更新在此 issue 中。 - 重要的事说三遍：**欢迎提交 PR！欢迎提交 PR！欢迎提交 PR！** -## 仓库目录 +## 文件说明 + +>![](documents/public_sys-resources/icon-note.gif) **说明：** +>- 建议直接使用本文档 [最新镜像](#最新镜像) 章节中给出的 openEuler 的树莓派镜像。 +>- 如需根据自身需求定制镜像，可参考 [openEuler 镜像的构建](documents/openEuler镜像的构建.md) 和 [交叉编译内核](documents/交叉编译内核.md)。 -- [scripts](./scripts): 构建 openEuler 树莓派镜像的脚本 - - [快速构建（不编译内核）](scripts/build-image.sh) - - [主机上构建（编译内核）](scripts/build-image-common.sh) - - [Docker 容器中构建（编译内核）](scripts/build-image-docker.sh) - [documents](./documents/): 使用文档 - - [openEuler 镜像的构建](documents/openEuler镜像的构建.md) - - [交叉编译内核](documents/交叉编译内核.md) - [刷写镜像](documents/刷写镜像.md) - [树莓派使用](documents/树莓派使用.md) + - [openEuler 镜像的构建](documents/openEuler镜像的构建.md) + - [交叉编译内核](documents/交叉编译内核.md) - [openEuler 20.03 LTS 内测版更新日志](documents/changelog/changelog-20.03-LTS.md) - [openEuler 20.09 内测版更新日志](documents/changelog/changelog-20.09.md) - [openEuler 20.09 内测版（含 Xfce 桌面环境）更新日志](documents/changelog/changelog-20.09-Xfce.md) @@ -38,6 +55,10 @@ SIG 组基本信息位于 [sig-RaspberryPi](https://gitee.com/jianminw/community - [openEuler 20.03 LTS SP1 内测版（含 UKUI 桌面环境）更新日志](documents/changelog/changelog-20.03-LTS-SP1-UKUI.md) - [openEuler 20.03 LTS SP1 内测版（含 DDE 桌面环境）更新日志](documents/changelog/changelog-20.03-LTS-SP1-DDE.md) - [openEuler 20.03 LTS SP1 更新日志](documents/changelog/changelog-20.03-LTS-SP1-release.md) +- [scripts](./scripts): 构建 openEuler 树莓派镜像的脚本 + - [快速构建（不编译内核）](scripts/build-image.sh) + - [主机上构建（编译内核）](scripts/build-image-common.sh) + - [Docker 容器中构建（编译内核）](scripts/build-image-docker.sh) ## 最新镜像 diff --git "a/documents/openEuler\351\225\234\345\203\217\347\232\204\346\236\204\345\273\272.md" "b/documents/openEuler\351\225\234\345\203\217\347\232\204\346\236\204\345\273\272.md" index f191c7ac43209ac0a9219c0842d29315606c1571..e2c52c51958698d2345b8026148cafac5200c0ca 100644 --- "a/documents/openEuler\351\225\234\345\203\217\347\232\204\346\236\204\345\273\272.md" +++ "b/documents/openEuler\351\225\234\345\203\217\347\232\204\346\236\204\345\273\272.md" @@ -56,6 +56,9 @@ +>![](public_sys-resources/icon-note.gif) **说明：** +>如需根据自身需求定制镜像，可参考本文档。 + # 环境需求 - 操作系统：openEuler 或 Centos 7/8； diff --git "a/documents/\344\272\244\345\217\211\347\274\226\350\257\221\345\206\205\346\240\270.md" "b/documents/\344\272\244\345\217\211\347\274\226\350\257\221\345\206\205\346\240\270.md" index e386851ed45585598ce81221fef942bf8f3883e4..cf25c0a110d34336e271e842f6fa49f28d48ae2b 100644 --- "a/documents/\344\272\244\345\217\211\347\274\226\350\257\221\345\206\205\346\240\270.md" +++ "b/documents/\344\272\244\345\217\211\347\274\226\350\257\221\345\206\205\346\240\270.md" @@ -22,6 +22,9 @@ # 介绍 +>![](public_sys-resources/icon-note.gif) **说明：** +>如需根据自身需求定制内核，可参考本文档。 + 目前 openEuler 树莓派版本只支持 AArch64 架构。 编译内核时，除了使用 AArch64 架构的运行环境，也可以采用交叉编译的方式。这里，我们以 ubuntu16.04 x86_64 的服务器上编译内核为例，介绍交叉编译的过程。 diff --git "a/documents/\346\240\221\350\216\223\346\264\276\344\275\277\347\224\250.md" "b/documents/\346\240\221\350\216\223\346\264\276\344\275\277\347\224\250.md" index 2d1fb2e2ac9f935e97ec69ad267c3e07ec372de0..8b56001bdd0d6a79bb186a74b239fb43ef3a7af6 100644 --- "a/documents/\346\240\221\350\216\223\346\264\276\344\275\277\347\224\250.md" +++ "b/documents/\346\240\221\350\216\223\346\264\276\344\275\277\347\224\250.md" @@ -236,7 +236,7 @@ Device Boot Start End Sectors Size Id Type Device 'wlan0' successfully activated with '26becaab-4adc-4c8e-9bf0-1d63cf5fa3f1'. ``` - >![](public_sys-resources/icon-note.gif) **说明：** + >![](public_sys-resources/icon-note.gif) **说明：** >如果使用 nmcli 命令连接失败，例如提示 `Error: Connection activation failed: (7) Secrets were required, but not provided.` 等错误，可尝试使用 nmtui 字符界面连接 wifi。 2. nmtui 字符界面 @@ -559,11 +559,11 @@ UART 的端口至少有 RX、TX 和地线三个针脚。RX 负责读取，TX 负 由于树莓派 4B 中，默认情况下，PL011 UART 分配给了新增的板载蓝牙模块，mini UART 用于 Linux 控制台进行串口通信。为了实现串口通信，我们可以使用 mini UART，也可以占用 PL011 UART。如果串口通信占用 PL011 UART，板载蓝牙就需要禁用或者使用 mini UART。 ->![](public_sys-resources/icon-note.gif) **说明：** +>![](public_sys-resources/icon-note.gif) **说明：** >注意树莓派的配置文件 /boot/config.txt 中 `enable_uart` 这个配置项，`enable_uart` 的默认值取决于 UART 的实际角色。 -> - 如果将 ttyAMA0 分配给蓝牙模块（默认），则 `enable_uart` 默认为 0，即不启用 GPIO 串口； -> - 如果将 mini UART 分配给蓝牙模块（`dtoverlay=pi3-miniuart-bt`），则 `enable_uart` 默认值为 1，即启用 GPIO 串口（使用 PL011 UART）； -> - 如果禁用蓝牙（`dtoverlay=pi3-disable-bt`），则默认将 ttyAMA0 分配给串口通信模块（使用 PL011 UART）。 +>- 如果将 ttyAMA0 分配给蓝牙模块（默认），则 `enable_uart` 默认为 0，即不启用 GPIO 串口； +>- 如果将 mini UART 分配给蓝牙模块（`dtoverlay=pi3-miniuart-bt`），则 `enable_uart` 默认值为 1，即启用 GPIO 串口（使用 PL011 UART）； +>- 如果禁用蓝牙（`dtoverlay=pi3-disable-bt`），则默认将 ttyAMA0 分配给串口通信模块（使用 PL011 UART）。 下面我们总结一下不同情况下的配置。