Improved build instructions

6.19.x
Tyler Jewell 2016-03-01 12:13:56 -08:00
parent bbeeb21bfe
commit 9b2b413863
1 changed files with 31 additions and 5 deletions

View File

@ -3,8 +3,7 @@
[![Eclipse License](http://img.shields.io/badge/license-Eclipse-brightgreen.svg)](https://github.com/codenvy/che/blob/master/LICENSE)
https://www.eclipse.org/che/
Next-generation Eclipse IDE. Open source workspace server and cloud IDE.
https://www.eclipse.org/che/. Next-generation Eclipse IDE. Open source workspace server and cloud IDE.
![Eclipse Che](https://www.eclipse.org/che/images/hero-home.png "Eclipse Che")
@ -46,11 +45,11 @@ If master is unstable, checkout the latest tagged version.
### Build and Run
```sh
cd che
cd che/assembly
mvn clean install
# A new assembly is packaged into:
cd /assembly/assembly-main/target/eclipse-che-<version>/eclipse-che-<version>
# A new assembly is placed in:
cd che/assembly/assembly-main/target/eclipse-che-<version>/eclipse-che-<version>
# Executable files are:
bin/che.sh
@ -58,6 +57,33 @@ bin/che.bat
```
Che will be available at ```localhost:8080```.
### Build Submodules
Building `/assembly` pulls already-built libraries for `core`, `plugins`, and `/dashboard` from our Nexus repository.
To build core:
```sh
# Install maven-patch-plugin as an additional dependency.
cd che/core
# Windows: maven-patch-plugin does not work, so skip tests when building:
# See: https://maven.apache.org/plugins/maven-patch-plugin/faq.html#Why_doesnt_this_work_on_Windows
mvn -DskipTests=true -Dfindbugs.skip=true -Dskip-validate-sources clean install
```
To build plugins:
```sh
cd che/plugins
mvn clean install
```
To build dashboard:
```sh
# You need NPM, Bower, and Gulp intsalled.
# See setup in /dashboard
cd che/dashboard
mvn clean install
```
### Run Che as a Server
If you want to run Che as a server where non-localhost clients connect, there are additional flags that you may need to configure. Please see the [usage documentation](https://eclipse-che.readme.io/docs/usage).