From 8c89003e1e03a264a1528d8868ca3f7e6a0b0526 Mon Sep 17 00:00:00 2001
From: yafen <yafen@iscas.ac.cn>
Date: Sun, 5 Apr 2020 11:45:03 +0800
Subject: [PATCH] readme for openEuler-1.0-LTS-raspi kernel

---
 README.en.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md    | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 151 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..cd278e0a4aca
--- /dev/null
+++ b/README.en.md
@@ -0,0 +1,75 @@
+# raspberrypi-kernel
+
+#### Description
+
+The openEuler-1.0-LTS kernel for running on Raspberry Pi, located at branch [openEuler-1.0-LTS-raspi](https://gitee.com/openeuler/raspberrypi-kernel/tree/openEuler-1.0-LTS-raspi/).
+
+This repository is built based on [openEuler-1.0-LTS kernel](https://gitee.com/openeuler/kernel/tree/openEuler-1.0-LTS/) and [Raspberry Pi kernel](https://github.com/raspberrypi/linux/tree/rpi-4.19.y).
+
+#### Architecture Requirements
+
+Hardware: Raspberry Pi 3B/3B+/4B.
+
+Architecture: AArch64.
+
+#### Compiling
+
+Compile kernel and kernel modules.
+
+1.  Prepare compile environment
+
+OS: openEuler or Centos 7/8;
+
+Architecture: ARM.
+
+For example, you can use [QEMU](https://www.qemu.org/) to build ARM system emulation.
+
+2.  Download source
+
+`git clone https://gitee.com/openeuler/raspberrypi-kernel.git`
+
+3.  Go to the source directory and checkout the openEuler-1.0-LTS-raspi branch
+
+`cd raspberrypi-kernel`
+
+`git checkout -b openEuler-1.0-LTS-raspi origin/openEuler-1.0-LTS-raspi`
+
+4.  Load default settings
+
+`make openeuler-raspi_defconfig`
+
+5.  Compile kernel
+
+`make ARCH=arm64 -j4`
+
+6.  Create directory for compiling kernel modules
+
+`mkdir ../output`
+
+7.  Compile kernel modules
+
+`make INSTALL_MOD_PATH=../output/ modules_install`
+
+Now, the kernel compilation is complete.
+
+#### Installation
+
+Refer to `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..50037bce003a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,76 @@
+# raspberrypi-kernel
+
+#### 介绍
+
+适用于树莓派的 openEuler-1.0-LTS 内核源码，位于本仓库分支：[openEuler-1.0-LTS-raspi](https://gitee.com/openeuler/raspberrypi-kernel/tree/openEuler-1.0-LTS-raspi/)。
+
+本仓库基于 [openEuler-1.0-LTS 内核](https://gitee.com/openeuler/kernel/tree/openEuler-1.0-LTS/) 和 [树莓派内核](https://github.com/raspberrypi/linux/tree/rpi-4.19.y)。
+
+
+#### 硬件要求
+
+硬件：树莓派 3B/3B+4B。
+
+架构：AArch64。
+
+#### 编译
+
+编译内核和内核模块。
+
+1.  准备编译环境
+
+操作系统：openEuler 或 Centos 7/8；
+
+架构：ARM。
+
+可以使用 [QEMU](https://www.qemu.org) 模拟器搭建 ARM 运行环境。
+
+2.  下载源码
+
+`git clone https://gitee.com/openeuler/raspberrypi-kernel.git`
+
+3.  进入源码目录并切换到openEuler-1.0-LTS-raspi分支
+
+`cd raspberrypi-kernel`
+
+`git checkout -b openEuler-1.0-LTS-raspi origin/openEuler-1.0-LTS-raspi`
+
+4.  载入默认设置
+
+`make openeuler-raspi_defconfig`
+
+5.  编译内核
+
+`make ARCH=arm64 -j4`
+
+6.  创建编译内核模块目录
+
+`mkdir ../output`
+
+7.  编译内核模块
+
+`make INSTALL_MOD_PATH=../output/ modules_install`
+
+至此，内核编译完成。
+
+#### 使用说明
+
+利用上面编译好的内核来构建镜像，具体文档参见`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/)
+
-- 
GitLab