You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ha...@apache.org on 2021/05/14 08:27:52 UTC
[iotdb] 01/02: update readme.md
This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch rdm
in repository https://gitbox.apache.org/repos/asf/iotdb.git
commit b962a5e102bf00fd4149f1d00649e96cc7c326bd
Author: HTHou <hh...@outlook.com>
AuthorDate: Fri May 14 16:03:30 2021 +0800
update readme.md
---
README.md | 19 ++++++++++---------
README_ZH.md | 13 +++++++------
2 files changed, 17 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
index 57dd722..fef9265 100644
--- a/README.md
+++ b/README.md
@@ -86,7 +86,7 @@ This short guide will walk you through the basic process of using IoTDB. For a m
To use IoTDB, you need to have:
-1. Java >= 1.8 (1.8, 11, and 13 are verified. Please make sure the environment path has been set accordingly).
+1. Java >= 1.8 (1.8, 11, and 15 are verified. Please make sure the environment path has been set accordingly).
2. Maven >= 3.6 (If you want to compile and install IoTDB from source code).
3. Set the max open files num as 65535 to avoid "too many open files" error.
@@ -99,7 +99,7 @@ IoTDB provides three installation methods, you can refer to the following sugges
* Using Docker：The path to the dockerfile is https://github.com/apache/iotdb/tree/master/docker/src/main
-Here in the Quick Start, we give a brief introduction of using source code to install IoTDB. For further information, please refer to Chapter 3 of the User Guide.
+Here in the Quick Start, we give a brief introduction of using source code to install IoTDB. For further information, please refer to [User Guide](https://iotdb.apache.org/UserGuide/Master/QuickStart/QuickStart.html).
## Build from source
@@ -137,7 +137,7 @@ You can download the source code from:
git clone https://github.com/apache/iotdb.git
```
-The default master branch is the dev branch, If you want to use a released version x.x.x:
+The default dev branch is the master branch, If you want to use a released version x.x.x:
```
git checkout release/x.x.x
@@ -159,11 +159,12 @@ Using `-P compile-cpp` for compiling cpp client (For more details, read client-c
Then the binary version (including both server and cli) can be found at **distribution/target/apache-iotdb-{project.version}-all-bin.zip**
-NOTE: Directories `thrift/target/generated-sources/thrift`, `thrift-sync/target/generated-sources/thrift`,
-`thrift-cluster/target/generated-sources/thrift`
-and `antlr/target/generated-sources/antlr4` need to be added to sources roots to avoid compilation errors in the IDE.
-In IDEAJ, you just need to right click on the root project name and choose "Maven->Reload Project" after
-you run `mvn package` successfully.
+**NOTE: Directories "`thrift/target/generated-sources/thrift`", "`thrift-sync/target/generated-sources/thrift`",
+"`thrift-cluster/target/generated-sources/thrift`"
+and "`antlr/target/generated-sources/antlr4`" need to be added to sources roots to avoid compilation errors in the IDE.**
+
+**In IDEA, you just need to right click on the root project name and choose "`Maven->Reload Project`" after
+you run `mvn package` successfully.**
### Configurations
@@ -173,7 +174,7 @@ configuration files are under "conf" folder
* system config module (`iotdb-engine.properties`)
* log config module (`logback.xml`).
-For more information, please see [Chapter3: Server](http://iotdb.apache.org/UserGuide/Master/Server/Config%20Manual.html).
+For more information, please see [Config Manual](https://iotdb.apache.org/UserGuide/Master/Appendix/Config-Manual.html).
## Start
diff --git a/README_ZH.md b/README_ZH.md
index 03bca8e..5f7b331 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -83,7 +83,7 @@ IoTDB的主要特点如下:
## 环境准备
要使用IoTDB，您需要:
-1. Java >= 1.8 (目前 1.8、11和13 已经被验证可用。请确保环变量境路径已正确设置)。
+1. Java >= 1.8 (目前 1.8、11和15 已经被验证可用。请确保环变量境路径已正确设置)。
2. Maven >= 3.6 (如果希望从源代码编译和安装IoTDB)。
3. 设置 max open files 为 65535，以避免"too many open files"错误。
@@ -97,7 +97,7 @@ IoTDB提供了三种安装方法，您可以参考以下建议，选择最适合
* 使用Docker: dockerfile的路径是https://github.com/apache/iotdb/tree/master/docker/src/main
-在这篇《快速入门》中，我们简要介绍如何使用源代码安装IoTDB。如需进一步资料，请参阅《用户指南》第3章。
+在这篇《快速入门》中，我们简要介绍如何使用源代码安装IoTDB。如需进一步资料，请参阅官网[用户指南](http://iotdb.apache.org/zh/UserGuide/Master/Get%20Started/QuickStart.html)。
## 从源码构建
@@ -127,7 +127,7 @@ Thrift官方网址为：https://thrift.apache.org/
git clone https://github.com/apache/iotdb.git
```
-默认的主分支是dev分支，如果你想使用某个发布版本x.x.x，请切换分支:
+默认的主分支是master分支，如果你想使用某个发布版本x.x.x，请切换分支:
```
git checkout release/x.x.x
@@ -148,8 +148,9 @@ git checkout vx.x.x
执行完成之后，可以在**distribution/target/apache-iotdb-{project.version}-all-bin.zip**找到编译完成的二进制版本(包括服务器和客户端)
-> 注意:"thrift/target/generated-sources/thrift" 和 "antlr/target/generated-sources/antlr4" 目录需要添加到源代码根中，以免在 IDE 中产生编译错误。
-> IDEA的操作方法：在上述maven命令编译好后，右键项目名称，选择"Maven->Reload project"，即可。
+**注意："`thrift/target/generated-sources/thrift`"， "`thrift-sync/target/generated-sources/thrift`"，"`thrift/target/generated-sources/thrift`" 和 "`antlr/target/generated-sources/antlr4`" 目录需要添加到源代码根中，以免在 IDE 中产生编译错误。**
+
+**IDEA的操作方法：在上述maven命令编译好后，右键项目名称，选择"`Maven->Reload project`"，即可。**
### 配置
@@ -158,7 +159,7 @@ git checkout vx.x.x
* 系统配置模块(`iotdb-engine.properties`)
* 日志配置模块(`logback.xml`)。
-有关详细信息，请参见[Chapter3: Server](http://iotdb.apache.org/zh/UserGuide/Master/Server/Config%20Manual.html)。
+有关详细信息，请参见[配置参数](https://iotdb.apache.org/zh/UserGuide/Master/Appendix/Config-Manual.html)。
## 开始