Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
whhe committed Apr 22, 2024
1 parent a82e43a commit ae36d6c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
6 changes: 5 additions & 1 deletion README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

本仓库提供了 OceanBase 的示例项目,按照编程语言进行分组,每个分组下面有一个或多个工具的使用示例,示例目录以工具名称命名。

本仓库使用 [oceanbase-ce](https://hub.docker.com/r/oceanbase/oceanbase-ce) 镜像在 GitHub 工作流中启动 OceanBase 数据库实例进行持续集成,用户也可以将所需工具对应的示例代码复制到本地,修改其中的连接信息后进行使用
您可以将示例代码复制到本地环境并在更改连接信息后直接使用,更多详细信息请参阅示例目录中的README文件

## 贡献

Expand All @@ -20,6 +20,10 @@
- `run.sh` 运行代码的脚本
- `README.md` 组件用法的介绍文档

如果您不能提供英文的文档,您可以在文档中使用您的母语,我们会在之后对其进行改进。

为了确保示例正常工作,请将您的模块添加到 GitHub CI 工作流程中,有关更多详细信息,请参阅 [ci.yml](./.github/workflows/ci.yml)

## 参考信息

关于更多 OceanBase 的细节请参考 [社区官网](https://open.oceanbase.com)
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ English | [简体中文](README-CN.md)

## Introduction

This repository provides the example projects for OceanBase, which are grouped by programming language. The example directory is named after the component name.
This repository provides the sample projects for OceanBase,which are grouped by programming language, and the sample directory is named after the component name.

This repository uses the [oceanbase-ce](https://hub.docker.com/r/oceanbase/oceanbase-ce) image to start the OceanBase database instance in the GitHub workflow for continuous integration. Users can also copy the example code to local environment and use it after changing the connection info.
You can copy the sample code to local environment and use it directly after changing the connection info, please see the README file in the sample directory for more details.

## Contribution

Expand All @@ -18,8 +18,11 @@ In the module, make sure to include the following files:

- code files
- `run.sh` script to run code
- `README.md` documentation for component usage
- Add your module's name to the github CI workflow ( please refer to https://github.com/oceanbase/ob-samples/.github/workflows/ci.yml )
- `README.md` documentation for component usage.

If it's hard to use English for you, you can use your native language in the documentation and we can improve it later.

To ensure the sample works, please add your module to the GitHub CI workflow, see [ci.yml](./.github/workflows/ci.yml) for more details.

## References

Expand Down

0 comments on commit ae36d6c

Please sign in to comment.