From 237dbe3925193f74886bf6b7648cc362eea44af1 Mon Sep 17 00:00:00 2001
From: yafen <yafen@iscas.ac.cn>
Date: Thu, 2 Sep 2021 19:25:27 +0800
Subject: [PATCH] refine readme

---
 README.en.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md    | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 146 insertions(+)
 create mode 100644 README.en.md
 create mode 100644 README.md

diff --git a/README.en.md b/README.en.md
new file mode 100644
index 000000000000..558778e58c0a
--- /dev/null
+++ b/README.en.md
@@ -0,0 +1,73 @@
+# raspberrypi-kernel
+
+English | [简体中文](./README.md)
+
+#### Description
+
+The 5.10 kernel for running on Raspberry Pi.
+
+This repository is based on [openEuler 21.09](https://gitee.com/openeuler/kernel/tree/openEuler-21.09/) version kernel, and is merged with the 5.10.y branch of [Raspberry Pi kernel](https://github.com/raspberrypi/linux/tree/rpi-5.10.y).
+
+#### Architecture Requirements
+
+Hardware: Raspberry Pi 3B/3B+/4B/400.
+
+Architecture: AArch64.
+
+#### Compiling
+
+Compile kernel and kernel modules.
+
+1.  Prepare compile environment
+
+    OS: openEuler or CentOS 7/8;
+
+    Architecture: AArch64.
+
+    You follow the documents of [raspberrypi](https://gitee.com/openeuler/raspberrypi/blob/master/README.en.md) to cross-compile this kernel.
+
+2.  Download source
+
+    `git clone git@gitee.com:openeuler/raspberrypi-kernel.git -b openEuler-21.09 && cd raspberrypi-kernel`
+
+3.  Load default settings
+
+    `make bcm2711_defconfig`
+
+    The corresponding defconfig file is in ./arch/arm64/configs.
+
+4.  Compile kernel
+
+    `make ARCH=arm64 -j4`
+
+5.  Create directory for compiling kernel modules
+
+    `mkdir ../output`
+
+6.  Compile kernel modules
+
+    `make INSTALL_MOD_PATH=../output/ modules_install`
+
+Now, the kernel compilation is complete.
+
+#### Installation
+
+Refer to [raspberrypi Repository](https://gitee.com/openeuler/raspberrypi) for details about how to use this compiled kernel to build openEuler image for Rasberry Pi.
+
+#### Contributions
+
+1.  Fork the repository
+2.  Create Feat_xxx branch
+3.  Commit your code
+4.  Create Pull Request
+
+
+#### Gitee Feature
+
+1.  You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
+2.  Gitee blog [blog.gitee.com](https://blog.gitee.com)
+3.  Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
+4.  The most valuable open source project [GVP](https://gitee.com/gvp)
+5.  The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
+6.  The most popular members  [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..4e5977997cbd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,73 @@
+# raspberrypi-kernel
+
+[English](./README.en.md) | 简体中文
+
+#### 介绍
+
+适用于树莓派 的 5.10 版本的内核源码。
+
+本仓库基于 [openEuler 21.09](https://gitee.com/openeuler/kernel/tree/openEuler-21.09/) 版本的内核，合并了上游 [树莓派内核 5.10.y](https://github.com/raspberrypi/linux/tree/rpi-5.10.y) 的分支代码。
+
+#### 支持硬件
+
+树莓派 3B/3B+/4B/400
+
+架构：AArch64
+
+#### 编译
+
+编译内核和内核模块。
+
+1.  准备编译环境
+
+    操作系统：openEuler 或 CentOS 7/8
+
+    架构：AArch64
+
+    交叉编译请参照：[交叉编译内核](https://gitee.com/openeuler/raspberrypi/blob/master/documents/交叉编译内核.md)
+
+2.  下载源码
+
+    `git clone git@gitee.com:openeuler/raspberrypi-kernel.git -b openEuler-21.09 && cd raspberrypi-kernel`
+
+3.  载入默认设置
+
+    `make bcm2711_defconfig`
+
+    对应的 defconfig 文件在 ./arch/arm64/configs 下。
+
+4.  编译内核
+
+    `make ARCH=arm64 -j4`
+
+5.  创建编译内核模块目录
+
+    `mkdir ../output`
+
+6.  编译内核模块
+
+    `make INSTALL_MOD_PATH=../output/ modules_install`
+
+至此，内核编译完成。
+
+#### 使用说明
+
+利用上面编译好的内核来构建镜像，具体文档参见 [raspberrypi 仓库](https://gitee.com/openeuler/raspberrypi)。
+
+#### 参与贡献
+
+1.  Fork 本仓库
+2.  新建 Feat_xxx 分支
+3.  提交代码
+4.  新建 Pull Request
+
+
+#### 码云特技
+
+1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
+2.  码云官方博客 [blog.gitee.com](https://blog.gitee.com)
+3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
+4.  [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
+5.  码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
+6.  码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+
-- 
Gitee