From 03a6f37590a72016b2d9bb5359b04519a80d7bac Mon Sep 17 00:00:00 2001 From: WANG Xu Date: Thu, 13 Mar 2025 16:12:18 +0800 Subject: [PATCH] docs: update readme for tdgpt Signed-off-by: WANG Xu --- README.md | 2 ++ tools/tdgpt/README.md | 11 ++++++----- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9bc6c5dd83..3399ad5b2d 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,8 @@ TDengine is an open source, high-performance, cloud native [time-series database For a full list of TDengine competitive advantages, please [check here](https://tdengine.com/tdengine/). The easiest way to experience TDengine is through [TDengine Cloud](https://cloud.tdengine.com). +For the latest TDengine component TDgpt, please refer to [TDgpt README](./tools/tdgpt/README.md) for details. + # 2. Documentation For user manual, system design and architecture, please refer to [TDengine Documentation](https://docs.tdengine.com) ([TDengine 文档](https://docs.taosdata.com)) diff --git a/tools/tdgpt/README.md b/tools/tdgpt/README.md index 0b61f8bcef..d67c6e2f91 100644 --- a/tools/tdgpt/README.md +++ b/tools/tdgpt/README.md @@ -14,7 +14,8 @@ 1. [Contributing](#12-contributing) # 1. Introduction -tdanalytics: an analytic platform for tdengine + +TDgpt: an analytic platform for TDengine # 2. Documentation @@ -70,7 +71,7 @@ cd script && ./release.sh After the packaging is completed, you will find the tarball in the `release` directory. ```bash -ls -lht /root/tdanalytics/release +ls -lht release -rw-rw-r-- 1 root root 74K Feb 21 17:04 TDengine-enterprise-anode-1.0.1.tar.gz ``` @@ -111,16 +112,16 @@ http = 127.0.0.1:6090 The command `rmtaosanode` will remove the installed taosanode from your system. Note that the python environment won't removed by this script, you need to remove it mannually. # 8. Testing -we use github Actions to run the test suit. Please refer to the file [.github/workflows/python-package.yml](https://github.com/taosdata/tdanalytics/.github/workflows/python-package.yml) for more details. +We use Github Actions to run the test suite. Please refer to the workflow definition yaml file in [.github/workflows](../../.github/workflows/) for details. # 9 Releasing + For the complete list of taosanode Releases, please see Releases. # 10 CI/CD -We use github Actions for CI/CD workflow configuration. Please refer to the file .github/workflows/python-package.yml for more details. - +We use Github Actions for CI/CD workflow configuration. Please refer to the workflow definition yaml file in [.github/workflows](../../.github/workflows/) for details. # 11 Coverage