diff --git a/README-CN.md b/README-CN.md index 697fee4a4..4126621aa 100644 --- a/README-CN.md +++ b/README-CN.md @@ -35,6 +35,14 @@ | Push consumer with concurrent message listener | ✅ | ✅ | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | | Push consumer with FIFO message listener | ✅ | ✅ | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | +## 先决条件和构建 + +由于本项目是以 monorepo 的形式组织的,因此如何构建它的说明可以在每种语言实现的子目录中找到。此外,由于 [rocketmq-apis](https://github.com/apache/rocketmq-apis) 作为一个子模块被包含在本项目中,可能会被一些语言绑定构建时所引用,因此我们强烈建议使用以下命令克隆此存储库: + +```sh +git clone --recursive git@github.com:apache/rocketmq-clients.git +``` + ## 参与贡献 与 Apache RocketMQ 的其他项目类似,我们欢迎任何形式的贡献,包括但不仅限于提交 bug 报告、勘误纠错、文档撰写或提交 feature。成为 Apache RocketMQ contributor,从第一个 issue/pull request 开始! diff --git a/README.md b/README.md index 37dfbb8ae..c5340592b 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,14 @@ Provide cloud-native and robust solutions for Java, C++, C#, Golang, Rust and al | Push consumer with concurrent message listener | ✅ | ✅ | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | | Push consumer with FIFO message listener | ✅ | ✅ | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | +## Prerequisite and Build + +As this project is structured as a monorepo, instructions on how to build it can be found in the subdirectories for each language's bindings. Since the [rocketmq-apis](https://github.com/apache/rocketmq-apis) submodule is included in this project and may be referenced by some bindings, we strongly recommend that you clone this repository using the following command: + +```sh +git clone --recursive git@github.com:apache/rocketmq-clients.git +``` + ## Contributing Similar to other projects of Apache RocketMQ, any attempt to make this project better is welcome, including but not limited to filing a bug report, correcting type error or document writing to complete feature implementation. Do not hesitate to make a pull request if this project catches your attention.