This is an automated email from the ASF dual-hosted git repository.
hxd pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new 0a85c19 Minor modification of README.md (#127)
0a85c19 is described below
commit 0a85c196e288614dfec8e56bce4b2b8dd656794a
Author: Jiaye Wu <[email protected]>
AuthorDate: Wed Apr 3 21:29:57 2019 +0800
Minor modification of README.md (#127)
* Minor modification of README.md, Recommend to use `mvnw`
* Rename Readme.md to README.md
* add +x permission to mvnw
---
Readme.md => README.md | 38 ++++++++++++++++++--------------------
mvnw.sh | 0
2 files changed, 18 insertions(+), 20 deletions(-)
diff --git a/Readme.md b/README.md
similarity index 86%
rename from Readme.md
rename to README.md
index 7bf847e..a418329 100644
--- a/Readme.md
+++ b/README.md
@@ -28,11 +28,11 @@
-[](http://iotdb.apache.org/)
+[](https://iotdb.apache.org/)
# Overview
-IoTDB(Internet of Things Database) is an integrated data management engine
designed for time series data, which can provide users specific services for
data collection, storage and analysis. Due to its light weight structure, high
performance and usable features together with its intense integration with
Hadoop and Spark ecology, IoTDB meets the requirements of massive dataset
storage, high-speed data input and complex data analysis in the IoT industrial
field.
+IoTDB (Internet of Things Database) is an integrated data management engine
designed for time series data, which can provide users specific services for
data collection, storage and analysis. Due to its light weight structure, high
performance and usable features together with its intense integration with
Hadoop and Spark ecology, IoTDB meets the requirements of massive dataset
storage, high-speed data input and complex data analysis in the IoT industrial
field.
# Main Features
@@ -46,34 +46,33 @@ IoTDB's features are as following:
6. Easy to get start. IoTDB supports SQL-Like language, JDBC standard API and
import/export tools which is easy to use.
7. Intense integration with Open Source Ecosystem. IoTDB supports Hadoop,
Spark, etc. analysis ecosystems and Grafana visualization tool.
-
-For the latest information about IoTDB, please visit our [IoTDB official
website](http://iotdb.apache.org/#/).
+For the latest information about IoTDB, please visit our [IoTDB official
website](https://iotdb.apache.org/).
# Prerequisites
-To use IoTDB, you need to have:
+IoTDB requires Java (>= 1.8), To use IoTDB, JRE should be installed.
-1. Java >= 1.8
-2. Maven >= 3.0 (If you want to compile and install IoTDB from source code)
+If you want to compile and install IoTDB from source code, JDK and Maven (>=
3.1) are required.
+While Maven is not mandatory to be installed standalone, you can use the
provided Maven wrapper, `./mvnw.sh` on Linux/OS X or `.\mvnw.cmd` on Windows,
to facilitate development.
If you want to use Hadoop or Spark to analyze IoTDB data file (called as
TsFile), you need to compile the hadoop and spark modules.
# Quick Start
-This short guide will walk you through the basic process of using IoTDB. For a
more-complete guide, please visit our website's [Document
Part](http://iotdb.apache.org/#/Documents/Quick%20Start).
+This short guide will walk you through the basic process of using IoTDB. For a
more-complete guide, please visit our website's [User
Guide](https://iotdb.apache.org/#/Documents/latest/sec1).
-### Installation from source code
+## Installation from source code
Use git to get IoTDB source code:
```
-Shell > git clone https://github.com/apache/incubator-iotdb.git
+> git clone https://github.com/apache/incubator-iotdb.git
```
-Or:
+Or use the following command if you have configured SSH key on GitHub:
```
-Shell > git clone [email protected]:apache/incubator-iotdb.git
+> git clone [email protected]:apache/incubator-iotdb.git
```
Now suppose your directory is like this:
@@ -97,6 +96,7 @@ incubator-iotdb/ <-- root path
```
Let $IOTDB_HOME = /workspace/incubator-iotdb/iotdb/iotdb/
+
Let $IOTDB_CLI_HOME = /workspace/incubator-iotdb/iotdb-cli/cli
If you are not the first time that building IoTDB, remember deleting the
following files:
@@ -135,7 +135,7 @@ Otherwise, you may need to check the error statements and
fix the problems.
After build, the IoTDB project will be at the folder "iotdb/iotdb". The folder
will include the following contents:
```
-iotdb/iotdb/ <-- root path
+iotdb/iotdb/ <-- root path
|
+- bin/ <-- script files
|
@@ -152,7 +152,7 @@ Before starting to use IoTDB, you need to config the
configuration files first.
In total, we provide users three kinds of configurations module: environment
config module (iotdb-env.bat, iotdb-env.sh), system config module
(tsfile-format.properties, iotdb-engine.properties) and log config module
(logback.xml). All of these kinds of configuration files are put in
iotdb/config folder.
-For more, you are advised to check our website [document
page](http://iotdb.apache.org/#/Documents/Quick%20Start). The forth chapter in
User Guide Document will give you the details.
+For more, you are advised to check our documentation [Chapter4: Deployment and
Management](https://iotdb.apache.org/#/Documents/latest/sec4) in detail.
## Start
@@ -173,7 +173,7 @@ After that we start the server. Running the startup script:
The server can be stopped with ctrl-C or the following script:
```
-# Unix/ OS X
+# Unix/OS X
> $IOTDB_HOME/bin/stop-server.sh
# Windows
@@ -266,7 +266,7 @@ execute successfully.
If your session looks similar to what's above, congrats, your IoTDB is
operational!
-For more on what commands are supported by IoTDB SQL, see our website
[document page](http://iotdb.apache.org/#/Documents/Quick%20Start). The eighth
chapter in User Guide Document will give you help.
+For more on what commands are supported by IoTDB SQL, see our documentation
[Chapter 5: IoTDB SQL
Documentation](https://iotdb.apache.org/#/Documents/latest/sec5).
# Usage of import-csv.sh
@@ -282,11 +282,9 @@ CREATE TIMESERIES root.fit.d2.s1 WITH
DATATYPE=INT32,ENCODING=RLE;
CREATE TIMESERIES root.fit.d2.s3 WITH DATATYPE=INT32,ENCODING=RLE;
CREATE TIMESERIES root.fit.p.s1 WITH DATATYPE=INT32,ENCODING=RLE;
```
-### Run import shell
+### Run import shell
```
-
-
# Unix/OS X
> $IOTDB_CLI_HOME/bin/import-csv.sh -h <ip> -p <port> -u <username> -pw
> <password> -f <xxx.csv>
@@ -296,7 +294,7 @@ CREATE TIMESERIES root.fit.p.s1 WITH
DATATYPE=INT32,ENCODING=RLE;
### Error data file
-csvInsertError.error
+`csvInsertError.error`
# Usage of export-csv.sh
diff --git a/mvnw.sh b/mvnw.sh
old mode 100644
new mode 100755
