You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by ki...@apache.org on 2022/03/26 14:51:05 UTC

[incubator-seatunnel] branch dev updated: [Docs][Readme]Add compile link and remove old docs (#1580)

This is an automated email from the ASF dual-hosted git repository.

kirs pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-seatunnel.git


The following commit(s) were added to refs/heads/dev by this push:
     new b9eded3  [Docs][Readme]Add compile link and remove old docs (#1580)
b9eded3 is described below

commit b9eded3648e993932cc8c87056b748ea31f1ff4f
Author: Kirs <ki...@apache.org>
AuthorDate: Sat Mar 26 22:50:59 2022 +0800

    [Docs][Readme]Add compile link and remove old docs (#1580)
    
    * [Docs][Readme]Add compile link and remove old docs
    
    * [Docs][Readme]Add compile link and remove old docs
---
 README.md                     |  3 +++
 build.md                      | 10 ----------
 docs/en/developement/setup.md |  5 ++---
 3 files changed, 5 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 8bf2b8b..a6d1801 100644
--- a/README.md
+++ b/README.md
@@ -136,6 +136,9 @@ If the data volume is small, or the goal is merely for functional verification,
 a cluster environment, because SeaTunnel supports standalone operation. Note: SeaTunnel 2.0 supports running on Spark
 and Flink.
 
+## Compiling project
+Follow this [document](docs/en/developement/setup.md).
+
 ## Downloads
 
 Download address for run-directly software package : https://seatunnel.apache.org/download
diff --git a/build.md b/build.md
deleted file mode 100644
index fe2a24b..0000000
--- a/build.md
+++ /dev/null
@@ -1,10 +0,0 @@
-## Compiling and Building seatunnel Source Code
-
-
-### How to Build Binary Release Package
-
-
-```
-mvn clean package -Dmaven.test.skip=true
-```
-After above command finish, you will see the seatunnel distribution source package `apache-seatunnel-incubating-${version}-src.tar.gz` and the binary package `apache-seatunnel-incubating-${version}-bin.tar.gz` in directory `seatunnel-dist/target/`.
\ No newline at end of file
diff --git a/docs/en/developement/setup.md b/docs/en/developement/setup.md
index ed4601d..b264409 100644
--- a/docs/en/developement/setup.md
+++ b/docs/en/developement/setup.md
@@ -14,7 +14,6 @@ have installed the following software:
 * [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed.
 * [Java](https://www.java.com/en/download/) (only JDK 8 supported by now) installed and `JAVA_HOME` set.
 * [Scala](https://www.scala-lang.org/download/2.11.8.html) (only scala 2.11.8 supported by now) installed.
-* [Maven](https://maven.apache.org/download.cgi) installed.
 * [JetBrains IDEA](https://www.jetbrains.com/idea/) installed.
 
 ## Set Up
@@ -29,11 +28,11 @@ git clone git@github.com:apache/incubator-seatunnel.git
 
 ### Install Subproject Locally
 
-After cloning the source code, you should run the `maven` command to install the subproject to the maven local repository.
+After cloning the source code, you should run the `./mvnw` command to install the subproject to the maven local repository.
 Otherwise, your code could not start in JetBrains IntelliJ IDEA correctly.
 
 ```shell
-mvn install
+./mvnw install -Dmaven.test.skip
 ```
 
 ### Install JetBrains IDEA Scala Plugin