From e056525c762a7802a1f10f41fb74ca7b251bbbe3 Mon Sep 17 00:00:00 2001
From: qevolg <2227465945@qq.com>
Date: Thu, 13 Feb 2025 17:18:51 +0800
Subject: [PATCH] docs: add taosKeeper and taosAdapter to README

---
 README-CN.md | 10 ++++++++++
 README.md    | 10 ++++++++++
 2 files changed, 20 insertions(+)

diff --git a/README-CN.md b/README-CN.md
index ca046dbe13..df6fd5549c 100644
--- a/README-CN.md
+++ b/README-CN.md
@@ -69,6 +69,8 @@ TDengine 是一款开源、高性能、云原生的时序数据库 (Time-Series
 
 TDengine 目前可以在 Linux、 Windows、macOS 等平台上安装和运行。任何 OS 的应用也可以选择 taosAdapter 的 RESTful 接口连接服务端 taosd。CPU 支持 X64/ARM64，后续会支持 MIPS64、Alpha64、ARM32、RISC-V 等 CPU 架构。目前不支持使用交叉编译器构建。
 
+如果你想要编译 taosAdapter 或者 taosKeeper，需要安装 Go 1.18 及以上版本。
+
 ## 3.1 Linux系统
 
 <details>
@@ -153,6 +155,10 @@ cmake .. -DBUILD_TOOLS=true -DBUILD_CONTRIB=true
 make
 ```
 
+如果你想要编译 taosAdapter，可以添加 `-DBUILD_HTTP=false` 选项。
+
+如果你想要编译 taosKeeper，可以添加 `--DBUILD_KEEPER=true` 选项。
+
 可以使用Jemalloc作为内存分配器，而不是使用glibc:
 
 ```bash
@@ -180,6 +186,10 @@ mkdir debug && cd debug
 cmake .. && cmake --build .
 ```
 
+如果你想要编译 taosAdapter，可以添加 `-DBUILD_HTTP=false` 选项。
+
+如果你想要编译 taosKeeper，可以添加 `--DBUILD_KEEPER=true` 选项。
+
 </details>
 
 ## 4.3 Windows系统上构建
diff --git a/README.md b/README.md
index 8034a68a6b..0b4f6a00d1 100644
--- a/README.md
+++ b/README.md
@@ -82,6 +82,8 @@ For contributing/building/testing TDengine Connectors, please check the followin
 
 At the moment, TDengine server supports running on Linux/Windows/MacOS systems. Any application can also choose the RESTful interface provided by taosAdapter to connect the taosd service. TDengine supports X64/ARM64 CPU, and it will support MIPS64, Alpha64, ARM32, RISC-V and other CPU architectures in the future. Right now we don't support build with cross-compiling environment.
 
+If you want to compile taosAdapter or taosKeeper, you need to install Go 1.18 or above.
+
 ## 3.1 On Linux
 
 <details>
@@ -168,6 +170,10 @@ cmake .. -DBUILD_TOOLS=true -DBUILD_CONTRIB=true
 make
 ```
 
+If you want to compile taosAdapter, you can add the `-DBUILD_HTTP=false` option.
+
+If you want to compile taosKeeper, you can add the `--DBUILD_KEEPER=true` option.
+
 You can use Jemalloc as memory allocator instead of glibc:
 
 ```bash
@@ -196,6 +202,10 @@ mkdir debug && cd debug
 cmake .. && cmake --build .
 ```
 
+If you want to compile taosAdapter, you can add the `-DBUILD_HTTP=false` option.
+
+If you want to compile taosKeeper, you can add the `--DBUILD_KEEPER=true` option.
+
 </details>
 
 ## 4.3 Build on Windows