From c31e751451d6e90699c927dea1c3376f55b925f1 Mon Sep 17 00:00:00 2001
From: xiezhiheng <xiezhiheng@huawei.com>
Date: Sat, 25 Dec 2021 15:03:09 +0800
Subject: [PATCH] [Readme] Add Readme description for GCC repo

---
 README.en.md | 43 ++++++++++++++++++-------------------------
 README.md    | 42 +++++++++++++++++-------------------------
 2 files changed, 35 insertions(+), 50 deletions(-)

diff --git a/README.en.md b/README.en.md
index 5850aad4bb2..af7ae74979e 100644
--- a/README.en.md
+++ b/README.en.md
@@ -1,36 +1,29 @@
-# gcc
+# GCC for openEuler
 
-#### Description
-gcc is a generic and open source compiler
+## GCC for openEuler 10.3.1
 
-#### Software Architecture
-Software architecture description
+The GCC for openEuler compiler is a high-performance compiler based on the open source GCC. GCC for openEuler works with Kunpeng chip to fully utilize the performance of the chip through compiler technology and improve the performance experience of the workload on the Kunpeng hardware platform. In addition to supporting open source GCC general functions, GCC for openEuler mainly enhances the following three aspects.
 
-#### Installation
+- Richer compilation algorithms: Provide a wealth of optimization algorithms, such as memory layout optimization, structure split optimization, automatic vectorization, etc., which greatly improve the throughput of instructions and data.
+- More flexible instruction pipeline: Adapt to the instruction pipeline of the Kunpeng platform, and give full play to the powerful performance of Kunpeng architecture.
+- More efficient operation library: Deeply optimize the mathematical library algorithm, provide a rich vector mathematical function interface, greatly improve the efficiency of mathematical calculations.
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+The binary can be downloaded from [here](https://www.hikunpeng.com/developer/devkit/compiler/gcc).
 
-#### Instructions
+For the user guide and new features, see [Wiki](https://support.huaweicloud.com/ug-hgcc-kunpengdevps/kunpenghgcc_06_0001.html) for details.
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+## Version planning
 
-#### Contribution
+GCC for openEuler releases a new version every two years, and chooses the version after x.2.y.
 
-1.  Fork the repository
-2.  Create Feat_xxx branch
-3.  Commit your code
-4.  Create Pull Request
+## Platform support
 
+GCC for openEuler currently supports `Linux/AArch64` and `Linux/x86` platforms.
 
-#### Gitee Feature
+## License
 
-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/)
+GCC for openEuler uses the GPLv3 License, please see [License](https://gitee.com/openeuler/gcc/blob/master/COPYING3).
+
+## How to submit a contribution
+
+We welcome developers to submit contributions. If you find a bug or have some ideas to exchange, welcome [send an email to the dev list](https://www.openeuler.org/zh/community/mailing-list/) Or [submit an issue](https://gitee.com/openeuler/gcc/issues).
\ No newline at end of file
diff --git a/README.md b/README.md
index d7d06aa7644..005383662e6 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,29 @@
-# gcc
+# GCC for openEuler
 
-#### 介绍
-gcc is a generic and open source compiler
+## GCC for openEuler 10.3.1
 
-#### 软件架构
-软件架构说明
+GCC for openEuler 编译器是基于开源 GCC 的高性能编译器，GCC for openEuler 与鲲鹏芯片协同，通过编译器技术充分发挥芯片的性能，提升鲲鹏硬件平台上业务的性能体验。除支持开源 GCC 通用功能之外，GCC for openEuler 主要对以下三个方面进行了增强。
 
+- 更丰富的编译算法：提供丰富的优化算法，如内存布局优化、结构体拆分优化、自动矢量化等，大幅提升指令和数据的吞吐量。
+- 更灵活的指令流水：适配鲲鹏平台的指令流水优化，发挥鲲鹏架构极致算力。
+- 更高效的运算库：深度优化数学库算法，提供丰富的矢量数学函数接口，大幅提升数学计算的效率。
 
-#### 安装教程
+二进制可以从[这里](https://www.hikunpeng.com/developer/devkit/compiler/gcc)下载。
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+用户指南和新特性，详见[Wiki](https://support.huaweicloud.com/ug-hgcc-kunpengdevps/kunpenghgcc_06_0001.html)。
 
-#### 使用说明
+## 版本节奏
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+GCC for openEuler 每两年发布一个新版本，选择x.2.y以后的版本。
 
-#### 参与贡献
+## 平台支持
 
-1.  Fork 本仓库
-2.  新建 Feat_xxx 分支
-3.  提交代码
-4.  新建 Pull Request
+GCC for openEuler 当前支持`Linux/AArch64`和`Linux/x86`平台。
 
+## License
 
-#### 特技
+GCC for openEuler 使用 GPLv3 协议，请见[License](https://gitee.com/openeuler/gcc/blob/master/COPYING3)。
 
-1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
-2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
-3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
-4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
-5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
-6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+## 如何提交贡献
+
+我们非常欢迎开发者提交贡献，如果您发现了一个bug或者有一些想法想要交流，欢迎[发邮件到dev列表](https://www.openeuler.org/zh/community/mailing-list/)或者[提交一个issue](https://gitee.com/openeuler/gcc/issues)。
\ No newline at end of file
-- 
Gitee