README update

2020-12-29 19:22:28 +08:00 · 2020-12-29 19:22:28 +08:00 · 302253cd4a
commit 302253cd4a
parent 71706676b1
2 changed files with 73 additions and 46 deletions
--- a/README.en.md
+++ b/README.en.md
@ -1,36 +1,51 @@
 # openGauss-OM

 #### Description
-{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**}
+Operation Manager provides management interfaces and tools for opengauss routine O&M and  configuration management.
+Common functions include database installtion, startup, stop, upgrade, backup, status query, and log collection.

-#### Software Architecture
-Software architecture description
+#### Compilation

+- See the compilation description of the [opengauss third-party-software](https://gitee.com/opengauss/openGauss-server/blob/master/README.en.md#compiling-third-party-software)。                     
+  The final compilation and build result is stored in the binarylibs directory at the same level as openGauss-third_party.                
+  The binarylibs directory will be the value of '-3rd' for build.sh                  
+- ./build.sh -3rd ${BINARYLIBS_PATH}              
+  The generated installation package is stored in the ./package directory:                 
+  openGauss-1.1.0-CentOS-64bit-om.sha256               
+  openGauss-1.1.0-CentOS-64bit-om.tar.gz              
+   
 #### Installation

-1.  xxxx
-2.  xxxx
-3.  xxxx
+The OM tool strongly depends on opengaussServer. Please see the [opengauss Installation](https://opengauss.org/zh/docs/latest/docs/installation/installation.html)。

-#### Instructions
+## Quick Start

-1.  xxxx
-2.  xxxx
-3.  xxxx
+See the [Quick Start](https://opengauss.org/en/docs/1.0.1/docs/Quickstart/Quickstart.html).

-#### Contribution
+## Docs

-1.  Fork the repository
-2.  Create Feat_xxx branch
-3.  Commit your code
-4.  Create Pull Request
+For more details about the installation guide, tutorials, and APIs, please see the [User Documentation](https://gitee.com/opengauss/docs).

+## Community

-#### Gitee Feature
+### Governance

-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/)
+Check out how openGauss implements open governance [works](https://gitee.com/opengauss/community/blob/master/governance.md).
+
+### Communication
+
+- WeLink- Communication platform for developers.
+- IRC channel at `#opengauss-meeting` (only for meeting minutes logging purpose)
+- Mailing-list: https://opengauss.org/en/community/onlineCommunication.html
+
+## Contribution
+
+Welcome contributions. See our [Contributor](https://opengauss.org/en/contribution.html) for more details.
+
+## Release Notes
+
+For the release notes, see our [RELEASE](https://opengauss.org/en/docs/1.0.1/docs/Releasenotes/Releasenotes.html).
+
+## License
+
+[MulanPSL-2.0](http://license.coscl.org.cn/MulanPSL2/)
--- a/README.md
+++ b/README.md
@ -1,39 +1,51 @@
 # openGauss-OM

 #### 介绍
-{**以下是 Gitee 平台说明，您可以替换此简介**
-Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台
-无论是个人、团队、或是企业，都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)}

-#### 软件架构
-软件架构说明
+运维管理模块(OperationManager)提供openGauss日常运维、配置管理的管理接口和工具
+
+#### 编译出包
+
+- 参考opengauss的[三方库说明](https://gitee.com/opengauss/openGauss-server#%E7%BC%96%E8%AF%91%E7%AC%AC%E4%B8%89%E6%96%B9%E8%BD%AF%E4%BB%B6)，准备好编译完的三方库，     
+  目录名记为 ${BINARYLIBS_PATH} 。        
+- ./build.sh -3rd ${BINARYLIBS_PATH}       
+  命令执行成功后，生成的包在package目录下：      
+  openGauss-1.1.0-CentOS-64bit-om.sha256      
+  openGauss-1.1.0-CentOS-64bit-om.tar.gz       


 #### 安装教程

-1.  xxxx
-2.  xxxx
-3.  xxxx
+OM工具强依赖opengaussServer，安装教程参考[opengauss安装指南](https://opengauss.org/zh/docs/latest/docs/installation/installation.html)。

-#### 使用说明
+## 快速入门

-1.  xxxx
-2.  xxxx
-3.  xxxx
+参考[快速入门](https://opengauss.org/zh/docs/1.0.1/docs/Quickstart/Quickstart.html)。

-#### 参与贡献
+## 文档

-1.  Fork 本仓库
-2.  新建 Feat_xxx 分支
-3.  提交代码
-4.  新建 Pull Request
+更多安装指南、教程和API请参考[用户文档](https://gitee.com/opengauss/docs)。

+## 社区

-#### 特技
+### 治理

-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/)
+查看openGauss是如何实现开放[治理](https://gitee.com/opengauss/community/blob/master/governance.md)。
+
+### 交流
+
+- WeLink：开发者的交流平台。
+- IRC频道：`#opengauss-meeting`（仅用于会议纪要）。
+- 邮件列表：https://opengauss.org/zh/community/onlineCommunication.html
+
+## 贡献
+
+欢迎大家来参与贡献。详情请参阅我们的[社区贡献](https://opengauss.org/zh/contribution.html)。
+
+## 发行说明
+
+请参见[发行说明](https://opengauss.org/zh/docs/1.0.1/docs/Releasenotes/Releasenotes.html)。
+
+## 许可证
+
+[MulanPSL-2.0](http://license.coscl.org.cn/MulanPSL2/)