Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
whhe committed May 30, 2024
1 parent 3cd7f65 commit dbcd6fd
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
11 changes: 6 additions & 5 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@

如下是本仓库已经添加或计划在近期添加的示例:

- application
- `hertzbeat` `sveltekit`
- applications
- `hertzbeat` `mydata` `sveltekit`
- TODO: `seatunnel`
- c
- TODO: `obconnector-c`
Expand All @@ -40,6 +40,8 @@
- python
- `mysql-connector-python` `pymysql` `sqlalchemy`
- TODO: `mysqlclient`
- ruby
- `activerecord` `mysql2` `sequel`
- rust
- TODO: `sqlx` `rust-mysql-simple` `obkv-table-client-rust`

Expand All @@ -59,15 +61,14 @@

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

为了确保示例能够在 GitHub Action 中运行,您的模块添加到 GitHub CI 工作流程。本项目对简单示例提供了一套标准化的运行流程,详情请参阅 [basic-workflow.yml](./.github/workflows/basic-workflow.yml)您只需要添加以下内容,将您贡献的模块增加到 [ci.yml](./.github/workflows/ci.yml) 中的 basic job 中即可:
为了确保示例能够在 GitHub Action 中运行,您的模块添加到 GitHub CI 工作流程。本项目对简单示例提供了一套标准化的运行流程,详情请参阅 [basic-workflow.yml](./.github/workflows/basic-workflow.yml)您只需要添加以下内容到 [.github/workflows](./.github/workflows) 目录下对应语言的 yml 中即可:

- `module.name`:新模块的名称,应与模块目录名称相同。
- `module.language`:编程语言,应与项目根目录下的目录名称相同。
- `module.with_oceanbase_container`:是否使用预先部署的 OceanBase 容器,可选,默认设置为 true。如果它是 true,您可以在 localhost 上使用用户名 `root@sys``root@test` 以及空密码连接到它。

#### 复杂示例

对于需要放到 applications 目录下的复杂示例,其目录内同样需要包含 `README.md` 文档,除此之外,其项目文件、ci 流程等由贡献者自行判断添加
对于需要放到 applications 目录下的复杂示例,其目录内同样需要包含项目文件和 `README.md` 文档,除此之外,您需要添加 ci 流程到 [application.yml](./.github/workflows/application.yml)

## 参考信息

Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ We have created some issues on GitHub for some samples which are simple and good

The following are samples that have been added or planned to be added in the near future:

- application
- `hertzbeat` `sveltekit`
- applications
- `hertzbeat` `mydata` `sveltekit`
- TODO: `seatunnel`
- c
- TODO: `obconnector-c`
Expand All @@ -40,6 +40,8 @@ The following are samples that have been added or planned to be added in the nea
- python
- `mysql-connector-python` `pymysql` `sqlalchemy`
- TODO: `mysqlclient`
- ruby
- `activerecord` `mysql2` `sequel`
- rust
- TODO: `sqlx` `rust-mysql-simple` `obkv-table-client-rust`

Expand All @@ -59,15 +61,14 @@ For a simple sample under the programming language category, the directory shoul

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 that the sample works, please add your module to the GitHub CI workflow. This project provides a standardized workflow for simple samples. For details, please refer to [basic-workflow.yml](./.github/workflows/basic-workflow.yml). You only need to add the following options to add your module to the `basic` job in [ci.yml](./.github/workflows/ci.yml):
To ensure that the sample works, please add your module to the GitHub CI workflow. This project provides a standardized workflow for simple samples. For details, please refer to [basic-workflow.yml](./.github/workflows/basic-workflow.yml). You only need to add the following options to the yml of the corresponding language in the [.github/workflows](./.github/workflows) directory:

- `module.name`: the name of new module, should be same with the module directory name.
- `module.language`: the programming language, should be same with the directory name under project root.
- `module.with_oceanbase_container`: whether to use a pre-deployed OceanBase container, optional, set 'true' by default. If it's 'true', you can connect to it using username 'root@sys' or 'root@test' with empty password at localhost.

#### Complex samples

For complex samples that need to be placed in the applications directory, the directory also needs to contain the `README.md` document. In addition, its project files, ci workflow, etc. will be added by yourself.
For complex samples that need to be placed in the applications directory, the directory also needs to contain project files and `README.md` document. In addition, you also need to add ci workflow to [application.yml](./.github/workflows/application.yml).

## References

Expand Down

0 comments on commit dbcd6fd

Please sign in to comment.