diff --git a/README-CN.md b/README-CN.md index 5e558dec294f090ea9cc372726a03c16f24938da..ae93aa73ae24243057938396d65223f7db55653e 100644 --- a/README-CN.md +++ b/README-CN.md @@ -21,14 +21,14 @@ OceanBase 数据库支持支付宝的全部核心业务,以及银行、保险 ## 快速上手 -请查看 [快速使用指南](https://open.oceanbase.com/quickStart) 开始试用 OceanBase 数据库。 +查看 [快速使用指南](https://open.oceanbase.com/quickStart) 开始试用 OceanBase 数据库。 ## 文档 - [简体中文](https://open.oceanbase.com/docs) - 英文(English)(Coming soon) -## 支持的客户端 +## 客户端 - [OBClient](https://github.com/oceanbase/obclient) @@ -40,47 +40,53 @@ OceanBase 数据库使用 [MulanPubL - 2.0](https://license.coscl.org.cn/MulanPu | 操作系统 | 版本 | 架构 | 编译 | 包部署 | 编译部署 | mysqltest | | ---- | ---- | ---- | ---- | ---- | ---- | ---- | -| CentOS | 7.2,8.3 | x86_64 | ✅ | ✅ | ✅ | ✅ | -| Debian | 9.8,10.9 | x86_64 | ✅ | ✅ | ✅ | ✅ | +| CentOS | 7.2, 8.3 | x86_64 | ✅ | ✅ | ✅ | ✅ | +| Debian | 9.8, 10.9 | x86_64 | ✅ | ✅ | ✅ | ✅ | | Fedora | 33 | x86_64 | ✅ | ✅ | ✅ | ✅ | | MacOS | any | x86_64 | ❌ | ❌ | ❌ | ❌ | | openSUSE | 15.2 | x86_64 | ✅ | ✅ | ✅ | ✅ | | OpenAnolis | 8.2 | x86_64 | ✅ | ✅ | ✅ | ✅ | | SUSE | 15.2 | x86_64 | ✅ | ✅ | ✅ | ✅ | -| Ubuntu | 16.04,18.04,20.04 | x86_64 | ✅ | ✅ | ✅ | ✅ | +| Ubuntu | 16.04, 18.04, 20.04 | x86_64 | ✅ | ✅ | ✅ | ✅ | ## 如何构建 -### 前置准备 +### 前提条件 -在构建前您需要确认您的机器已经安装必要的软件 +在构建前您需要确认您的机器已经安装必要的软件: #### Fedora 系列 (包括 CentOS,Fedora,OpenAnolis,RedHat 等) + ```sh yum install git wget rpm* cpio make glibc-devel glibc-headers binutils ``` #### Debian 系列 (包括 Debian,ubuntu 等) + ```sh apt-get install git wget rpm rpm2cpio cpio make build-essential binutils ``` #### SUSE 系列 (包括 SUSE,openSUSE 等) + ```sh zypper install git wget rpm cpio make glibc-devel binutils ``` ### debug 模式 + ```bash bash build.sh debug --init --make ``` ### release 模式 + ```bash bash build.sh release --init --make ``` -### 构建 rpm 软件包 +### 构建 RPM 软件包 + ```bash bash build.sh rpm --init && cd build_rpm && make -j16 rpm ``` diff --git a/README.md b/README.md index 757cf0c3ffa47a0e12d572eb0bde80a9e3ffdcf5..0cb71e1364f955d6c2a1c78a502988294db0a54e 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ OceanBase Database supports the entire core business of Alipay and the core syst ## Quick start -Refer to the [Get Started guide](https://open.oceanbase.com/quickStart) (Simplified Chinese, English will be ready soon) to try out OceanBase Database. +Refer to the [Get Started guide](doc/quick-start-en.md) to try out OceanBase Database. ## Documentation @@ -40,14 +40,14 @@ OceanBase Database is under [MulanPubL - 2.0](https://license.coscl.org.cn/Mulan | OS | Ver. | Arch | Compilable | Package Deployable | Compiled Binary Deployable | Mysqltest Passed | | ---- | ---- | ---- | ---- | ---- | ---- | ---- | -| CentOS | 7.2,8.3 | x86_64 | ✅ | ✅ | ✅ | ✅ | -| Debian | 9.8,10.9 | x86_64 | ✅ | ✅ | ✅ | ✅ | +| CentOS | 7.2, 8.3 | x86_64 | ✅ | ✅ | ✅ | ✅ | +| Debian | 9.8, 10.9 | x86_64 | ✅ | ✅ | ✅ | ✅ | | Fedora | 33 | x86_64 | ✅ | ✅ | ✅ | ✅ | | MacOS | any | x86_64 | ❌ | ❌ | ❌ | ❌ | | openSUSE | 15.2 | x86_64 | ✅ | ✅ | ✅ | ✅ | | OpenAnolis | 8.2 | x86_64 | ✅ | ✅ | ✅ | ✅ | | SUSE | 15.2 | x86_64 | ✅ | ✅ | ✅ | ✅ | -| Ubuntu | 16.04,18.04,20.04 | x86_64 | ✅ | ✅ | ✅ | ✅ | +| Ubuntu | 16.04, 18.04, 20.04 | x86_64 | ✅ | ✅ | ✅ | ✅ | ## How to build @@ -56,31 +56,37 @@ OceanBase Database is under [MulanPubL - 2.0](https://license.coscl.org.cn/Mulan Before building, you need to confirm that your device has installed the necessary software. #### Fedora based (, including CentOS, Fedora, OpenAnolis, RedHat, etc.) + ```sh yum install git wget rpm* cpio make glibc-devel glibc-headers binutils ``` #### Debian based (, including Debian, Ubuntu, etc.) + ```sh apt-get install git wget rpm rpm2cpio cpio make build-essential binutils ``` #### SUSE based (, including SUSE, openSUSE, etc.) + ```sh zypper install git wget rpm cpio make glibc-devel binutils ``` ### debug mode + ```bash bash build.sh debug --init --make ``` ### release mode + ```bash bash build.sh release --init --make ``` -### rpm packages +### RPM packages + ```bash bash build.sh rpm --init && cd build_rpm && make -j16 rpm ``` @@ -98,4 +104,4 @@ In case you have any problems when using OceanBase Database, welcome reach out f - [GitHub Issue](https://github.com/oceanbase/oceanbase/issues) - [Official Website](https://open.oceanbase.com/) -- Knowledge base [link TODO] +- Knowledge base [Coming soon]