Merge pull request #30337 from taosdata/docs/fix-windows
docs:add Windows support restriction details in README.md
This commit is contained in:
commit
58939469ac
79
README.md
79
README.md
|
@ -80,7 +80,9 @@ For contributing/building/testing TDengine Connectors, please check the followin
|
|||
|
||||
# 3. Prerequisites
|
||||
|
||||
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.
|
||||
At the moment, TDengine server supports running on Linux/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.
|
||||
|
||||
Starting from version 3.1.0.0, TDengine supports the Windows system exclusively in its Enterprise edition.
|
||||
|
||||
If you want to compile taosAdapter or taosKeeper, you need to install Go 1.18 or above.
|
||||
|
||||
|
@ -125,13 +127,7 @@ brew install argp-standalone gflags pkgconfig
|
|||
|
||||
## 3.3 Prerequisites on Windows
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Install required tools on Windows</summary>
|
||||
|
||||
Work in Progress.
|
||||
|
||||
</details>
|
||||
Not available for community edition.
|
||||
|
||||
## 3.4 Clone the repo
|
||||
|
||||
|
@ -210,40 +206,7 @@ If you want to compile taosKeeper, you need to add the `-DBUILD_KEEPER=true` opt
|
|||
|
||||
## 4.3 Build on Windows
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Detailed steps to build on Windows</summary>
|
||||
|
||||
If you use the Visual Studio 2013, please open a command window by executing "cmd.exe".
|
||||
Please specify "amd64" for 64 bits Windows or specify "x86" for 32 bits Windows when you execute vcvarsall.bat.
|
||||
|
||||
```cmd
|
||||
mkdir debug && cd debug
|
||||
"C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcvarsall.bat" < amd64 | x86 >
|
||||
cmake .. -G "NMake Makefiles"
|
||||
nmake
|
||||
```
|
||||
|
||||
If you use the Visual Studio 2019 or 2017:
|
||||
|
||||
please open a command window by executing "cmd.exe".
|
||||
Please specify "x64" for 64 bits Windows or specify "x86" for 32 bits Windows when you execute vcvarsall.bat.
|
||||
|
||||
```cmd
|
||||
mkdir debug && cd debug
|
||||
"c:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat" < x64 | x86 >
|
||||
cmake .. -G "NMake Makefiles"
|
||||
nmake
|
||||
```
|
||||
|
||||
Or, you can simply open a command window by clicking Windows Start -> "Visual Studio < 2019 | 2017 >" folder -> "x64 Native Tools Command Prompt for VS < 2019 | 2017 >" or "x86 Native Tools Command Prompt for VS < 2019 | 2017 >" depends what architecture your Windows is, then execute commands as follows:
|
||||
|
||||
```cmd
|
||||
mkdir debug && cd debug
|
||||
cmake .. -G "NMake Makefiles"
|
||||
nmake
|
||||
```
|
||||
</details>
|
||||
Not available for community edition.
|
||||
|
||||
# 5. Packaging
|
||||
|
||||
|
@ -283,17 +246,7 @@ sudo make install
|
|||
|
||||
## 6.3 Install on Windows
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Detailed steps to install on windows</summary>
|
||||
|
||||
After building successfully, TDengine can be installed by:
|
||||
|
||||
```cmd
|
||||
nmake install
|
||||
```
|
||||
|
||||
</details>
|
||||
Not available for community edition.
|
||||
|
||||
# 7. Running
|
||||
|
||||
|
@ -358,25 +311,7 @@ If TDengine CLI connects the server successfully, welcome messages and version i
|
|||
|
||||
## 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>
|
||||
Not available for community edition.
|
||||
|
||||
# 8. Testing
|
||||
|
||||
|
|
|
@ -19,6 +19,9 @@ This manual is intended to give developers a comprehensive guidance to test TDen
|
|||
> - The commands and scripts below are verified on Linux (Ubuntu 18.04/20.04/22.04).
|
||||
> - [taos-connector-python](https://github.com/taosdata/taos-connector-python) is used by tests written in Python, which requires Python 3.7+.
|
||||
> - The commands and steps described below are to run the tests on a single host.
|
||||
> - The testing framework is currently compatible with Python versions 3.8 through 3.10.
|
||||
> - Vitural Environment is advised when setting up the environment, pease refer to [venv](https://docs.python.org/3/library/venv.html) for details.
|
||||
|
||||
|
||||
# 2. Prerequisites
|
||||
|
||||
|
|
Loading…
Reference in New Issue