From 4e2e7b3d4a920c076f3375c9c93cf1955fff8f1d Mon Sep 17 00:00:00 2001
From: zhaoshujian <zhaoshujian@huawei.com>
Date: Tue, 20 Aug 2024 16:26:12 +0800
Subject: [PATCH] Add README.md for gcc-toolset-14.

Signed-off-by: zhaoshujian <zhaoshujian@huawei.com>
---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 40 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index b87855d..5a084a6 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,55 @@
 # gcc-14
 
 #### 介绍
-gcc multi-version toolset for openEuler
+openEuler 24.03 LTS 版本选择 GCC 12.3.1 作为开发基线，确保在整 LTS 周期内，系统版本保持相对稳定。
 
+为满足用户对不同版本编译器的需求，使能多样算力新特性，基于 openEuler 24.09 系统，推出 gcc-toolset-14 副版本编译工具链，形成主版本为 GCC12，副版本为 GCC14 的编译器搭配，为用户提供更加灵活且高效的编译选择。
 #### 软件架构
-软件架构说明
 
+```shell
+## 默认 GCC12 路径
+PATH=/usr/bin/
+## 默认动态库路径
+LD_LIBRARY_PATH=/usr/lib64/
+
+## gcc-toolset-14 副版本安装路径
+PATH=/opt/openEuler/gcc-toolset-14/root/usr/bin/
+```
+
+#### 软件约束
+
+| 名称| 版本要求|
+| --- | --- |
+| 系统版本| openEuler 24.09 以上 |
+| 默认GCC |  12.3.1 |
+| 架构 | Aarch64 / X86_64|
+| Glibc | 2.34 及以上 |
+| Binutils | 2.42 及以上|
+
+约束是指本多版本工具链在以上条件的版本中进行了完整的工程验证和兼容性测试，如果使用在其他场景中，不保证完整功能实现。
 
 #### 安装教程
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+1.  `yum install gcc-toolset-14-gcc gcc-toolset-14-g++`
+2.  如果需要搭配 binutils-2.42，则 `yum install gcc-toolset-14-binutils`
 
 #### 使用说明
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+1.  安装 scl
+> yum install scl-utils
+
+2.  注册 gcc-toolset-14
+> scl register /opt/openEuler/gcc-toolset-14/
+
+使用`scl list-collections`显示 gcc-toolset-14 已经在 scl 中注册成功；
+
+3.  切换 gcc-toolset-14
+> scl enable gcc-toolset-14 bash
+
+4.  退出 gcc-toolset-14
+> exit
+
+退出bash shell会话，此时 GCC 的版本切换成系统默认版本。
 
 #### 参与贡献
 
-- 
Gitee