xxq250
/
homework-jianmu
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: update README

This commit is contained in:
qevolg 2025-02-13 19:37:03 +08:00
parent e056525c76
commit b6bd7a8c9a
2 changed files with 60 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README-CN.md
View File

@ -10,33 +10,34 @@
简体中文 | [English](README.md) | [TDengine 云服务](https://cloud.taosdata.com/?utm_medium=cn&utm_source=github) | 很多职位正在热招中，请看[这里](https://www.taosdata.com/careers/) 简体中文 | [English](README.md) | [TDengine 云服务](https://cloud.taosdata.com/?utm_medium=cn&utm_source=github) | 很多职位正在热招中，请看[这里](https://www.taosdata.com/careers/)
<!-- omit in toc -->
# 目录 # 目录
1. [TDengine 简介](#1-tdengine-简介) - [1. 简介](#1-简介)
1. [文档](#2-文档) - [2. 文档](#2-文档)
1. [必备工具](#3-必备工具) - [3. 前置条件](#3-前置条件)
- [3.1 Linux预备](#31-linux系统) - [3.1 Linux系统](#31-linux系统)
- [3.2 macOS预备](#32-macos系统) - [3.2 macOS系统](#32-macos系统)
- [3.3 Windows预备](#33-windows系统) - [3.3 Windows系统](#33-windows系统)
- [3.4 克隆仓库](#34-克隆仓库) - [3.4 克隆仓库](#34-克隆仓库)
1. [构建](#4-构建) - [4. 构建](#4-构建)
- [4.1 Linux系统上构建](#41-linux系统上构建) - [4.1 Linux系统上构建](#41-linux系统上构建)
- [4.2 macOS系统上构建](#42-macos系统上构建) - [4.2 macOS系统上构建](#42-macos系统上构建)
- [4.3 Windows系统上构建](#43-windows系统上构建) - [4.3 Windows系统上构建](#43-windows系统上构建)
1. [打包](#5-打包) - [5. 打包](#5-打包)
1. [安装](#6-安装) - [6. 安装](#6-安装)
- [6.1 Linux系统上安装](#61-linux系统上安装) - [6.1 Linux系统上安装](#61-linux系统上安装)
- [6.2 macOS系统上安装](#62-macos系统上安装) - [6.2 macOS系统上安装](#62-macos系统上安装)
- [6.3 Windows系统上安装](#63-windows系统上安装) - [6.3 Windows系统上安装](#63-windows系统上安装)
1. [快速运行](#7-快速运行) - [7. 快速运行](#7-快速运行)
- [7.1 Linux系统上运行](#71-linux系统上运行) - [7.1 Linux系统上运行](#71-linux系统上运行)
- [7.2 macOS系统上运行](#72-macos系统上运行) - [7.2 macOS系统上运行](#72-macos系统上运行)
- [7.3 Windows系统上运行](#73-windows系统上运行) - [7.3 Windows系统上运行](#73-windows系统上运行)
1. [测试](#8-测试) - [8. 测试](#8-测试)
1. [版本发布](#9-版本发布) - [9. 版本发布](#9-版本发布)
1. [工作流](#10-工作流) - [10. 工作流](#10-工作流)
1. [覆盖率](#11-覆盖率) - [11. 覆盖率](#11-覆盖率)
1. [成为社区贡献者](#12-成为社区贡献者) - [12. 成为社区贡献者](#12-成为社区贡献者)
# 1. 简介 # 1. 简介
@ -155,9 +156,9 @@ cmake .. -DBUILD_TOOLS=true -DBUILD_CONTRIB=true
make make
``` ```
如果你想要编译 taosAdapter，可以添加 `-DBUILD_HTTP=false` 选项。 如果你想要编译 taosAdapter，需要添加 `-DBUILD_HTTP=false` 选项。
如果你想要编译 taosKeeper，可以添加 `--DBUILD_KEEPER=true` 选项。 如果你想要编译 taosKeeper，需要添加 `--DBUILD_KEEPER=true` 选项。
可以使用Jemalloc作为内存分配器，而不是使用glibc: 可以使用Jemalloc作为内存分配器，而不是使用glibc:
@ -186,9 +187,9 @@ mkdir debug && cd debug
cmake .. && cmake --build . cmake .. && cmake --build .
``` ```
如果你想要编译 taosAdapter，可以添加 `-DBUILD_HTTP=false` 选项。 如果你想要编译 taosAdapter，需要添加 `-DBUILD_HTTP=false` 选项。
如果你想要编译 taosKeeper，可以添加 `--DBUILD_KEEPER=true` 选项。 如果你想要编译 taosKeeper，需要添加 `--DBUILD_KEEPER=true` 选项。
</details> </details>

41
README.md
View File

@ -24,33 +24,34 @@
English | [简体中文](README-CN.md) | [TDengine Cloud](https://cloud.tdengine.com) | [Learn more about TSDB](https://tdengine.com/tsdb/) English | [简体中文](README-CN.md) | [TDengine Cloud](https://cloud.tdengine.com) | [Learn more about TSDB](https://tdengine.com/tsdb/)
<!-- omit in toc -->
# Table of Contents # Table of Contents
1. [Introduction](#1-introduction) - [1. Introduction](#1-introduction)
1. [Documentation](#2-documentation) - [2. Documentation](#2-documentation)
1. [Prerequisites](#3-prerequisites) - [3. Prerequisites](#3-prerequisites)
- [3.1 Prerequisites On Linux](#31-on-linux) - [3.1 On Linux](#31-on-linux)
- [3.2 Prerequisites On macOS](#32-on-macos) - [3.2 On macOS](#32-on-macos)
- [3.3 Prerequisites On Windows](#33-on-windows) - [3.3 On Windows](#33-on-windows)
- [3.4 Clone the repo](#34-clone-the-repo) - [3.4 Clone the repo](#34-clone-the-repo)
1. [Building](#4-building) - [4. Building](#4-building)
- [4.1 Build on Linux](#41-build-on-linux) - [4.1 Build on Linux](#41-build-on-linux)
- [4.2 Build on macOS](#42-build-on-macos) - [4.2 Build on macOS](#42-build-on-macos)
- [4.3 Build On Windows](#43-build-on-windows) - [4.3 Build on Windows](#43-build-on-windows)
1. [Packaging](#5-packaging) - [5. Packaging](#5-packaging)
1. [Installation](#6-installation) - [6. Installation](#6-installation)
- [6.1 Install on Linux](#61-install-on-linux) - [6.1 Install on Linux](#61-install-on-linux)
- [6.2 Install on macOS](#62-install-on-macos) - [6.2 Install on macOS](#62-install-on-macos)
- [6.3 Install on Windows](#63-install-on-windows) - [6.3 Install on Windows](#63-install-on-windows)
1. [Running](#7-running) - [7. Running](#7-running)
- [7.1 Run TDengine on Linux](#71-run-tdengine-on-linux) - [7.1 Run TDengine on Linux](#71-run-tdengine-on-linux)
- [7.2 Run TDengine on macOS](#72-run-tdengine-on-macos) - [7.2 Run TDengine on macOS](#72-run-tdengine-on-macos)
- [7.3 Run TDengine on Windows](#73-run-tdengine-on-windows) - [7.3 Run TDengine on Windows](#73-run-tdengine-on-windows)
1. [Testing](#8-testing) - [8. Testing](#8-testing)
1. [Releasing](#9-releasing) - [9. Releasing](#9-releasing)
1. [Workflow](#10-workflow) - [10. Workflow](#10-workflow)
1. [Coverage](#11-coverage) - [11. Coverage](#11-coverage)
1. [Contributing](#12-contributing) - [12. Contributing](#12-contributing)
# 1. Introduction # 1. Introduction
@ -170,9 +171,9 @@ cmake .. -DBUILD_TOOLS=true -DBUILD_CONTRIB=true
make make
``` ```
If you want to compile taosAdapter, you can add the `-DBUILD_HTTP=false` option. If you want to compile taosAdapter, you need add the `-DBUILD_HTTP=false` option.
If you want to compile taosKeeper, you can add the `--DBUILD_KEEPER=true` option. If you want to compile taosKeeper, you need add the `--DBUILD_KEEPER=true` option.
You can use Jemalloc as memory allocator instead of glibc: You can use Jemalloc as memory allocator instead of glibc:
@ -202,9 +203,9 @@ mkdir debug && cd debug
cmake .. && cmake --build . cmake .. && cmake --build .
``` ```
If you want to compile taosAdapter, you can add the `-DBUILD_HTTP=false` option. If you want to compile taosAdapter, you need add the `-DBUILD_HTTP=false` option.
If you want to compile taosKeeper, you can add the `--DBUILD_KEEPER=true` option. If you want to compile taosKeeper, you need add the `--DBUILD_KEEPER=true` option.
</details> </details>