From 5eb75151f7ba6f33c4a25cee831b764b0d583137 Mon Sep 17 00:00:00 2001
From: johnnyhou327 <31071594+johnnyhou327@users.noreply.github.com>
Date: Mon, 15 Jul 2019 20:05:44 +0800
Subject: [PATCH] Create readme.md

---
 tests/examples/JDBC/readme.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 tests/examples/JDBC/readme.md

diff --git a/tests/examples/JDBC/readme.md b/tests/examples/JDBC/readme.md
new file mode 100644
index 0000000..54a2e5c
--- /dev/null
+++ b/tests/examples/JDBC/readme.md
@@ -0,0 +1,13 @@
+# How to Run the JDBC Demo Code On A Linux OS
+TDengine's JDBC demo project is organized in a Maven way so that users can easily compile, package and run the project. If you don't have Maven on your server, you may install it using
+<pre>sudo apt-get install maven</pre>
+
+## Compile and Install JDBC Driver
+TDengine's JDBC driver jar is not yet published to maven center repo, so we need to manually compile it and install it to the local Maven repository. This can be easily done with Maven. Go to source directory of the JDBC driver ``TDengine/src/connector/jdbc`` and execute
+<pre>mvn clean package install</pre>
+
+## Compile the Demo Code and Run It
+To compile the demo project, go to the source directory ``TDengine/tests/examples/JDBC/JDBCDemo`` and execute
+<pre>mvn clean assembly:single package</pre>
+The ``pom.xml`` is configured to package all the dependencies into one executable jar file. To run it, go to ``TDengine/tests/examples/JDBC/JDBCDemo/target`` and execute
+<pre>java -jar jdbcdemo-1.0-SNAPSHOT-jar-with-dependencies.jar</pre>
-- 
GitLab