Merge pull request #28991 from taosdata/docs/xwang/refactor-toc
refactor: toc
This commit is contained in:
WANG Xu
GitHub
commit
6ed276d0f9
64
README.md
64
README.md
|
|
@ -24,16 +24,25 @@
|
|||
English | [简体中文](README-CN.md) | [TDengine Cloud](https://cloud.tdengine.com) | [Learn more about TSDB](https://tdengine.com/tsdb/)
|
||||
|
||||
# Table of Contents
|
||||
1. [What is TDengine?](#what-is-tdengine)
|
||||
1. [Documentation](#documentation)
|
||||
1. [Building](#building)
|
||||
1. [Installing](#installing)
|
||||
1. [Try TDengine](#try-tdengine)
|
||||
1. [Developing with TDengine](#developing-with-tdengine)
|
||||
1. [Contribute to TDengine](#contribute-to-tdengine)
|
||||
1. [Join the TDengine Community](#join-the-tdengine-community)
|
||||
|
||||
# What is TDengine？
|
||||
1. [What is TDengine?](#1-what-is-tdengine)
|
||||
2. [Documentation](#2-documentation)
|
||||
3. [Building](#3-building)
|
||||
1. [Install build tools](#31-install-build-tools)
|
||||
1. [Get the source codes](#32-get-the-source-codes)
|
||||
1. [Special Note](#33-special-note)
|
||||
1. [Build TDengine](#34-build-tdengine)
|
||||
4. [Installing](#4-installing)
|
||||
1. [On Linux platform](#41-on-linux-platform)
|
||||
1. [On Windows platform](#42-on-windows-platform)
|
||||
1. [On macOS platform](#43-on-macos-platform)
|
||||
1. [Quick Run](#44-quick-run)
|
||||
5. [Try TDengine](#5-try-tdengine)
|
||||
6. [Developing with TDengine](#6-developing-with-tdengine)
|
||||
7. [Contribute to TDengine](#7-contribute-to-tdengine)
|
||||
8. [Join the TDengine Community](#8-join-the-tdengine-community)
|
||||
|
||||
# 1. What is TDengine？
|
||||
|
||||
TDengine is an open source, high-performance, cloud native [time-series database](https://tdengine.com/tsdb/) optimized for Internet of Things (IoT), Connected Cars, and Industrial IoT. It enables efficient, real-time data ingestion, processing, and monitoring of TB and even PB scale data per day, generated by billions of sensors and data collectors. TDengine differentiates itself from other time-series databases with the following advantages:
|
||||
|
||||
|
|
@ -43,19 +52,19 @@ TDengine is an open source, high-performance, cloud native [time-series database
|
|||
|
||||
- **[Cloud Native](https://tdengine.com/tdengine/cloud-native-time-series-database/)**: Through native distributed design, sharding and partitioning, separation of compute and storage, RAFT, support for kubernetes deployment and full observability, TDengine is a cloud native Time-Series Database and can be deployed on public, private or hybrid clouds.
|
||||
|
||||
- **[Ease of Use](https://tdengine.com/tdengine/easy-time-series-data-platform/)**: For administrators, TDengine significantly reduces the effort to deploy and maintain. For developers, it provides a simple interface, simplified solution and seamless integrations for third party tools. For data users, it gives easy data access.
|
||||
- **[Ease of Use](https://tdengine.com/tdengine/easy-time-series-data-platform/)**: For administrators, TDengine significantly reduces the effort to deploy and maintain. For developers, it provides a simple interface, simplified solution and seamless integrations for third party tools. For data users, it gives easy data access.
|
||||
|
||||
- **[Easy Data Analytics](https://tdengine.com/tdengine/time-series-data-analytics-made-easy/)**: Through super tables, storage and compute separation, data partitioning by time interval, pre-computation and other means, TDengine makes it easy to explore, format, and get access to data in a highly efficient way.
|
||||
- **[Easy Data Analytics](https://tdengine.com/tdengine/time-series-data-analytics-made-easy/)**: Through super tables, storage and compute separation, data partitioning by time interval, pre-computation and other means, TDengine makes it easy to explore, format, and get access to data in a highly efficient way.
|
||||
|
||||
- **[Open Source](https://tdengine.com/tdengine/open-source-time-series-database/)**: TDengine’s core modules, including cluster feature, are all available under open source licenses. It has gathered 19.9k stars on GitHub. There is an active developer community, and over 139k running instances worldwide.
|
||||
|
||||
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 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).
|
||||
|
||||
# Documentation
|
||||
# 2. Documentation
|
||||
|
||||
For user manual, system design and architecture, please refer to [TDengine Documentation](https://docs.tdengine.com) ([TDengine 文档](https://docs.taosdata.com))
|
||||
|
||||
# Building
|
||||
# 3. 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.
|
||||
|
||||
|
|
@ -65,7 +74,7 @@ TDengine provide a few useful tools such as taosBenchmark (was named taosdemo) a
|
|||
|
||||
To build TDengine, use [CMake](https://cmake.org/) 3.13.0 or higher versions in the project directory.
|
||||
|
||||
## Install build tools
|
||||
## 3.1 Install build tools
|
||||
|
||||
### Ubuntu 18.04 and above or Debian
|
||||
|
||||
|
|
@ -158,7 +167,7 @@ cmake .. -DBUILD_HTTP=false
|
|||
|
||||
TDengine includes a few components developed by Rust language. Please refer to rust-lang.org official documentation for rust environment setup.
|
||||
|
||||
## Get the source codes
|
||||
## 3.2 Get the source codes
|
||||
|
||||
First of all, you may clone the source codes from github:
|
||||
|
||||
|
|
@ -174,11 +183,11 @@ You can modify the file ~/.gitconfig to use ssh protocol instead of https for be
|
|||
insteadOf = https://github.com/
|
||||
```
|
||||
|
||||
## Special Note
|
||||
## 3.3 Special Note
|
||||
|
||||
[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) and [Grafana plugin](https://github.com/taosdata/grafanaplugin) has been moved to standalone repository.
|
||||
|
||||
## Build TDengine
|
||||
## 3.4 Build TDengine
|
||||
|
||||
### On Linux platform
|
||||
|
||||
|
|
@ -254,9 +263,9 @@ mkdir debug && cd debug
|
|||
cmake .. && cmake --build .
|
||||
```
|
||||
|
||||
# Installing
|
||||
# 4. Installing
|
||||
|
||||
## On Linux platform
|
||||
## 4.1 On Linux platform
|
||||
|
||||
After building successfully, TDengine can be installed by
|
||||
|
||||
|
|
@ -282,7 +291,7 @@ taos
|
|||
|
||||
If TDengine CLI connects the server successfully, welcome messages and version info are printed. Otherwise, an error message is shown.
|
||||
|
||||
## On Windows platform
|
||||
## 4.2 On Windows platform
|
||||
|
||||
After building successfully, TDengine can be installed by:
|
||||
|
||||
|
|
@ -290,8 +299,7 @@ After building successfully, TDengine can be installed by:
|
|||
nmake install
|
||||
```
|
||||
|
||||
|
||||
## On macOS platform
|
||||
## 4.3 On macOS platform
|
||||
|
||||
After building successfully, TDengine can be installed by:
|
||||
|
||||
|
|
@ -317,7 +325,7 @@ taos
|
|||
|
||||
If TDengine CLI connects the server successfully, welcome messages and version info are printed. Otherwise, an error message is shown.
|
||||
|
||||
## Quick Run
|
||||
## 4.4 Quick Run
|
||||
|
||||
If you don't want to run TDengine as a service, you can run it in current shell. For example, to quickly start a TDengine server after building, run the command below in terminal: (We take Linux as an example, command on Windows will be `taosd.exe`)
|
||||
|
||||
|
|
@ -333,7 +341,7 @@ In another terminal, use the TDengine CLI to connect the server:
|
|||
|
||||
option "-c test/cfg" specifies the system configuration file directory.
|
||||
|
||||
# Try TDengine
|
||||
# 5. Try TDengine
|
||||
|
||||
It is easy to run SQL commands from TDengine CLI which is the same as other SQL databases.
|
||||
|
||||
|
|
@ -351,7 +359,7 @@ SELECT * FROM t;
|
|||
Query OK, 2 row(s) in set (0.001700s)
|
||||
```
|
||||
|
||||
# Developing with TDengine
|
||||
# 6. Developing with TDengine
|
||||
|
||||
## Official Connectors
|
||||
|
||||
|
|
@ -366,11 +374,11 @@ TDengine provides abundant developing tools for users to develop on TDengine. Fo
|
|||
- [C#](https://docs.tdengine.com/reference/connectors/csharp/)
|
||||
- [RESTful API](https://docs.tdengine.com/reference/connectors/rest-api/)
|
||||
|
||||
# Contribute to TDengine
|
||||
# 7. Contribute to TDengine
|
||||
|
||||
Please follow the [contribution guidelines](CONTRIBUTING.md) to contribute to the project.
|
||||
|
||||
# Join the TDengine Community
|
||||
# 8. Join the TDengine Community
|
||||
|
||||
For more information about TDengine, you can follow us on social media and join our Discord server:
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue