update README to adjust the structure

README.md

@@ -29,15 +29,28 @@ English | [简体中文](README-CN.md) | [TDengine Cloud](https://cloud.tdengine
 1. [Introduction](#1-introduction)
 1. [Documentation](#2-documentation)
 1. [Prerequisites](#3-prerequisites)
-1. [Building](#4-building)
+    - [3.1 Prerequisites On Linux](#31-on-linux)
-1. [Packaging](#5-packaging)
+    - [3.2 Prerequisites On macOS](#32-on-macos)
-1. [Installation](#6-installation)
+    - [3.3 Prerequisites On Windows](#33-on-windows) 
-1. [Running](#7-running)
+    - [3.4 Clone the repo](#34-clone-the-repo) 
-1. [Testing](#8-testing)
+2. [Building](#4-building)
-1. [Releasing](#9-releasing)
+    - [4.1 Build on Linux](#41-build-on-linux)
-1. [CI/CD](#10-cicd)
+    - [4.2 Build on macOS](#42-build-on-macos)
-1. [Coverage](#11-coverage)
+    - [4.3 Build On Windows](#43-build-on-windows) 
-1. [Contributing](#12-contributing)
+3. [Packaging](#5-packaging)
+4. [Installation](#6-installation)
+    - [6.1 Install on Linux](#61-install-on-linux)
+    - [6.2 Install on macOS](#62-install-on-macos)
+    - [6.3 Install on Windows](#63-install-on-windows)
+5. [Running](#7-running)
+    - [7.1 Run TDengine on Linux](#71-run-tdengine-on-linux)
+    - [7.2 Run TDengine on macOS](#72-run-tdengine-on-macos)
+    - [7.3 Run TDengine on Windows](#73-run-tdengine-on-windows)
+6. [Testing](#8-testing)
+7. [Releasing](#9-releasing)
+8. [CI/CD](#10-cicd)
+9.  [Coverage](#11-coverage)
+10. [Contributing](#12-contributing)
 
 # 1. Introduction
 
@@ -65,7 +78,11 @@ For user manual, system design and architecture, please refer to [TDengine Docum
 
 ## 3.1 On Linux
 
-### For Ubuntu 18.04 or Later
+<details>
+
+<summary>Install required tools on Linux</summary>
+
+### For Ubuntu 18.04、20.04、22.04
 
 ```bash
 sudo apt-get udpate
@@ -82,36 +99,38 @@ yum config-manager --set-enabled powertools
 yum install -y zlib-static xz-devel snappy-devel jansson-devel pkgconfig libatomic-static libstdc++-static 
 ```
 
-### For Fedora or Rocky Linux
+</details>
-
-```bash
-sudo dnf install -y gcc gcc-c++ make cmake git perl
-sudo dnf install -y zlib-devel xz-devel snappy-devel jansson-devel pkgconfig
-```
-
-To build the [taosTools](https://github.com/taosdata/taos-tools) on Fedora or Rocky, the following packages need to be installed.
-
-```bash
-sudo dnf install -y dnf-plugins-core
-sudo dnf config-manager --set-enabled powertools
-sudo dnf install -y zlib-devel zlib-static xz-devel snappy-devel jansson \
-  jansson-devel pkgconfig libatomic libatomic-static libstdc++-static
-```
 
 ## 3.2 On macOS
 
+<details>
+
+<summary>Install required tools on macOS</summary>
+
 Please intall the dependencies with [brew](https://brew.sh/).
 
 ```bash
 brew install argp-standalone gflags pkgconfig
 ```
 
+</details>
+
 ## 3.3 On Windows
 
+<details>
+
+<summary>Install required tools on Windows</summary>
+
 Work in Progress.
 
+</details>
+
 ## 3.4 Clone the repo
 
+<details>
+
+<summary>Clone the repo</summary>
+
 Clone the repository to the target machine:
 
 ```bash
@@ -122,6 +141,8 @@ cd TDengine
 > [!NOTE]
 > TDengine Connectors can be found in following repositories: [JDBC Connector](https://github.com/taosdata/taos-connector-jdbc), [Go Connector](https://github.com/taosdata/driver-go), [Python Connector](https://github.com/taosdata/taos-connector-python), [Node.js Connector](https://github.com/taosdata/taos-connector-node), [C# Connector](https://github.com/taosdata/taos-connector-dotnet), [Rust Connector](https://github.com/taosdata/taos-connector-rust).
 
+</details>
+
 # 4. Building
 
 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.
@@ -307,29 +328,7 @@ Option `-c test/cfg` specifies the system configuration file directory.
 
 </details>
 
-## 7.2 Run TDengine on Windows
+## 7.2 Run TDengine on macOS
-
-<details>
-
-<summary>Detailed steps to run on windows</summary>
-
-You can start TDengine server on Windows platform with below commands:
-
-```cmd
-.\build\bin\taosd.exe -c test\cfg
-```
-
-In another terminal, use the TDengine CLI to connect the server:
-
-```cmd
-.\build\bin\taos.exe -c test\cfg
-```
-
-option "-c test/cfg" specifies the system configuration file directory.
-
-</details>
-
-## 7.3 Run TDengine on macOS
 
 <details>
 
@@ -351,6 +350,29 @@ If TDengine CLI connects the server successfully, welcome messages and version i
 
 </details>
 
+
+## 7.3 Run TDengine on Windows
+
+<details>
+
+<summary>Detailed steps to run on windows</summary>
+
+You can start TDengine server on Windows platform with below commands:
+
+```cmd
+.\build\bin\taosd.exe -c test\cfg
+```
+
+In another terminal, use the TDengine CLI to connect the server:
+
+```cmd
+.\build\bin\taos.exe -c test\cfg
+```
+
+option "-c test/cfg" specifies the system configuration file directory.
+
+</details>
+
 # 8. Testing
 
 For how to run different types of tests on TDengine, please see [Testing TDengine](./tests/README.md).
@@ -359,14 +381,9 @@ For how to run different types of tests on TDengine, please see [Testing TDengin
 
 For the complete list of TDengine Releases, please see [Releases](https://github.com/taosdata/TDengine/releases).
 
-# 10. CI/CD
+# 10. Workflow
 
-Now, Jenkins is mainly used to build CI/CD pipeline for TDengine. To run the tests in the CI/CD pipeline, please run following commands:
+Now, Jenkins is mainly used to build CI/CD pipeline for TDengine. 
-
-```bash
-cd tests
-./run_all_ci_cases.sh -b main # on main branch
-```
 
 TDengine build check workflow can be found in this [Github Action](https://github.com/taosdata/TDengine/actions/workflows/taosd-ci-build.yml).
 

tests/README.md

@@ -8,12 +8,15 @@
     1. [Smoke Test](#33-smoke-test)
     1. [Legacy Test](#34-legacy-test)
     1. [Chaos Test](#35-chaos-test)
-    1. [TSBS Test](#36-tsbs-test)
+    1. [CI Test](#36-ci-test)
 
 # 1. Introduction
 
 This manual is intended to provide users with comprehensive guidance to help them verify the TDengine function efficiently. The document is divided into three main sections: introduction, prerequisites and testing guide.
 
+> [!NOTICE]
+> The below commands and test scripts are verified on linux (Ubuntu 18.04、20.04、22.04) locally.
+
 # 2. Prerequisites
 
 - Install Python3
@@ -126,39 +129,19 @@ cd tests/script
 
 [Placeholder]
 
-## 3.6. TSBS Test
+## 3.6 CI Test
 
-[Time Series Benchmark Suite (TSBS)](https://github.com/timescale/tsbs) is an open-source performance benchmarking platform specifically designed for time-series data processing systems, such as databases. It provides a standardized approach to evaluating the performance of various databases by simulating typical use cases such as IoT and DevOps.
+[Desciprtion]
 
 ### How to run tests?
 
-1. Clone the code and  run the tests locally on your machine. Ensure that your virtual machine supports the AVX instruction set:
+To run the CI tests, please run following commands:
+
 ```bash
-  cd /usr/local/src && git clone https://github.com/taosdata/tsbs-internal.git tsbs && \
+cd tests
-  cd tsbs &&  git checkout enh/chr-td-33357 && \
+./run_all_ci_cases.sh -b main # on main branch
-  cd scripts/tsdbComp && ./testTsbs.sh  
 ```
-> [!NOTE]
-> The default case type, CPU test, takes a long time to run.
-> 
-> If you want to run quick test to verify the test environment, please set `caseType=cputest` in test.ini .
 
+### How to add new cases?
 
-2. When testing the client and server on separate machines, you should set up your environment as outlined in the steps below:
+[Placeholder]
-
-    2.1. Modify IP and host of client and server in `test.ini`
-    ```ini
-    clientIP="192.168.0.203"   # client ip
-    clientHost="trd03"         # client hostname
-    serverIP="192.168.0.204"   # server ip
-    serverHost="trd04"         # server hostname
-    ```
-    2.2. Set up passwordless login between the client and server; otherwise, you'll need to configure the server password:
-    ```ini
-    serverPass="taosdata123"   # server root password
-    ```
-    2.3. Run the following command to start the test:
-     ```bash
-    ./testTsbs.sh  
-    ```
-3. When the test is done, the result can be found in `/data2/` directory, which can also be configured in `test.ini`.