Skip to content

Commit

Permalink
docs: add description about applications
Browse files Browse the repository at this point in the history
  • Loading branch information
whhe committed Apr 22, 2024
1 parent ae36d6c commit 552de67
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
8 changes: 5 additions & 3 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,18 @@

## 介绍

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

对于基础的示例,我们将它们按照编程语言分组,示例目录以工具名称命名。

对于作为独立应用程序工作的示例,我们将它们放在 applications 目录下,示例目录名称一般包含主要工具名和用途。

您可以将示例代码复制到本地环境并在更改连接信息后直接使用,更多详细信息请参阅示例目录中的README文件。

## 贡献

我们欢迎任何人来贡献,感谢所有的[贡献者](https://github.com/oceanbase/ob-example/graphs/contributors)

如果您想增加 OceanBase 的使用示例,请确保将新增的示例代码放置在对应的编程语言目录下,并以工具名称命名该新增模块。

在一个示例中,请确保包含以下内容

- 代码文件
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,25 @@ English | [简体中文](README-CN.md)

## Introduction

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 provides the sample projects for OceanBase.

For basic sample projects, we group them by the programming language, and the sample directories are named after the component name.

For sample projects that works as standalone applications, we put them under `applications` directory, and the module name typically contains the component name and purpose.

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

We welcome contributions from anyone, thanks to all [contributors](https://github.com/oceanbase/ob-samples/graphs/contributors)!

If you want to add a new module, please make sure to place it in the directory of corresponding programming language and name it after the component name.

In the module, make sure to include the following files:

- code files
- `run.sh` script to run code
- `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.
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.

Expand Down

0 comments on commit 552de67

Please sign in to comment.