From d1172a53be592cc93f2906ba59f5f0c0d70298da Mon Sep 17 00:00:00 2001 From: Xjxjy <2639419212@qq.com> Date: Tue, 30 Aug 2022 10:50:28 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9=20readme=20=E6=96=87?= =?UTF-8?q?=E4=BB=B6=E4=B8=AD=E7=9A=84=E8=B7=B3=E8=BD=AC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README-CN.md | 34 ++++++++++++++++++---------------- README.md | 34 ++++++++++++++++++---------------- 2 files changed, 36 insertions(+), 32 deletions(-) diff --git a/README-CN.md b/README-CN.md index 950f525..67b9ff1 100644 --- a/README-CN.md +++ b/README-CN.md @@ -28,19 +28,21 @@ source /etc/profile.d/obd.sh - pip - pyinstaller -> 说明: -> +> **说明** +> > 您可以参考如下命令在拥有 Python2.7 或 Python3.8 的环境中安装 pip: -> ```shell -> curl -o get-pip.py https://bootstrap.pypa.io/pip/2.7/get-pip.py # 针对 Python2.7 环境 -> curl -o get-pip.py https://bootstrap.pypa.io/get-pip.py # 针对 Python3.8 环境 -> sudo python get-pip.py -> ``` -> +> +> ```shell +> curl -o get-pip.py https://bootstrap.pypa.io/pip/2.7/get-pip.py # 针对 Python2.7 环境 +> curl -o get-pip.py https://bootstrap.pypa.io/get-pip.py # 针对 Python3.8 环境 +> sudo python get-pip.py +> ``` +> > 然后使用如下 pip 命令安装 pyinstaller: -> ```shell -> sudo pip install pyinstaller==3.6 -> ``` +> +> ```shell +> sudo pip install pyinstaller==3.6 +> ``` Python2.7 使用以下命令安装： @@ -74,7 +76,7 @@ source /etc/profile.d/obd.sh - 您的机器内存应该不低于 8 G。 - 您的机器 CPU 数目应该不低于 2。 -> **说明：** 如果以上条件不满足，请参考[使用 OBD 启动 OceanBase 数据库集群](./docs/docs-cn/install-and-use/start-OceanBase-cluster-with-obd.md)。 +> **说明：** 如果以上条件不满足，请参考[使用 OBD 启动 OceanBase 数据库集群](./docs/zh-CN/3.user-guide/2.start-the-oceanbase-cluster-by-using-obd.md)。 > **注意：** 此处为了方便使用 root，OBD 和 OceanBase 数据库没有对运行用户做出任何限制，我们不建议生产中直接使用 root。 @@ -87,15 +89,15 @@ mysql -h127.1 -uroot -P2883 ## 使用 OBD 启动 OceanBase 数据库集群 -如何使用 OBD 启动 OceanBase 数据库集群，请参考文档[使用 OBD 启动 OceanBase 数据库集群](./docs/docs-cn/install-and-use/start-OceanBase-cluster-with-obd.md) +如何使用 OBD 启动 OceanBase 数据库集群，请参考文档[使用 OBD 启动 OceanBase 数据库集群](./docs/zh-CN/3.user-guide/2.start-the-oceanbase-cluster-by-using-obd.md) ## 其他 OBD 命令 OBD 有多级命令，您可以在每个层级中使用 `-h/--help` 选项查看子命令的帮助信息。 -- [镜像和仓库命令组](./docs/docs-cn/obd-commands/mirror-and-repository-commands.md) -- [集群命令组](./docs/docs-cn/obd-commands/cluster-commands.md) -- [测试命令组](./docs/docs-cn/obd-commands/testing-commands.md) +- [镜像和仓库命令组](./docs/zh-CN/3.user-guide/3.obd-command/2.command-group-for-mirroring-and-warehousing.md) +- [集群命令组](./docs/zh-CN/3.user-guide/3.obd-command/1.cluster-command-groups.md) +- [测试命令组](./docs/zh-CN/3.user-guide/3.obd-command/3.test-command-group.md) ## Q&A diff --git a/README.md b/README.md index 4c9df0a..be11f90 100644 --- a/README.md +++ b/README.md @@ -29,19 +29,20 @@ Before you install OBD by using the source code, make sure that you have install - pyinstaller > Notes: -> +> > You can install pip for Python2.7 or Python3.8 refer below cmd: -> ```shell -> curl -o get-pip.py https://bootstrap.pypa.io/pip/2.7/get-pip.py # for Python2.7 -> curl -o get-pip.py https://bootstrap.pypa.io/get-pip.py # for Python3.8 -> sudo python get-pip.py -> ``` -> +> +> ```shell +> curl -o get-pip.py https://bootstrap.pypa.io/pip/2.7/get-pip.py # for Python2.7 +> curl -o get-pip.py https://bootstrap.pypa.io/get-pip.py # for Python3.8 +> sudo python get-pip.py +> ``` +> > then install pyinstaller as below: -> ```shell -> sudo pip install pyinstaller==3.6 -> ``` - +> +> ```shell +> sudo pip install pyinstaller==3.6 +> ``` To install OBD on Python2.7, run these commands: @@ -73,7 +74,7 @@ Before you run the commands, make sure that these conditions are met: - Your server has at least 8 GB of memory. - Your server has at least 2 CPU cores. -> **NOTE:** If the preceding conditions are not met, see [Use OBD to start an OceanBase cluster](./docs/docs-en/install-and-use/start-OceanBase-cluster-with-obd.md). +> **NOTE:** If the preceding conditions are not met, see [Use OBD to start an OceanBase cluster](./docs/en-US/3.user-guide/2.start-the-oceanbase-cluster-by-using-obd.md). > **NOTE:** For the convenience of using root here, OBD and OceanBase database do not have any restrictions on running users. We do not recommend that you use root in production. @@ -86,15 +87,15 @@ mysql -h127.1 -uroot -P2883 ## Use OBD to start an OceanBase cluster -If you want to know how to use OBD to start an OceanBase cluster, please see [Use OBD to start an OceanBase cluster](./docs/docs-en/install-and-use/start-OceanBase-cluster-with-obd.md). +If you want to know how to use OBD to start an OceanBase cluster, please see [Use OBD to start an OceanBase cluster](./docs/en-US/3.user-guide/2.start-the-oceanbase-cluster-by-using-obd.md). ## Other OBD commands OBD provides multiple-level commands. You can use the`-h/--help` option to view the help information of sub-commands. -- [Mirror and repository commands](./docs/docs-en/obd-commands/mirror-and-repository-commands.md) -- [Cluster commands](./docs/docs-en/obd-commands/cluster-commands.md) -- [Testing commands](./docs/docs-en/obd-commands/testing-commands.md) +- [Mirror and repository commands](./docs/en-US/3.user-guide/3.obd-command/2.command-group-for-mirroring-and-warehousing.md) +- [Cluster commands](./docs/en-US/3.user-guide/3.obd-command/1.cluster-command-groups.md) +- [Testing commands](./docs/en-US/3.user-guide/3.obd-command/3.test-command-group.md) ## Q&A @@ -137,4 +138,5 @@ A：You can use the `obd update` command to update OBD. When you are done with t OBD complies with [GPL-3.0](/LICENSE). ## TPC-C + - [Run TPC-C benchmark test on OceanBase](https://github.com/oceanbase/oceanbase-doc/blob/V3.1.4/en-US/1.Get-Started/5.Experience-OceanBase-Advanced-Features/1.Experience-Scalable-OLTP/1.Run-the-TPC-C-benchmark-test-in-OceanBase-Database.md) -- GitLab