eclair/BUILD.md

# Building Eclair

## Requirements
- [OpenJDK 11](https://jdk.java.net/11/).
- [Maven](https://maven.apache.org/download.cgi) 3.5.4 or newer
- [Docker](https://www.docker.com/) 18.03 or newer (optional) if you want to run all tests

:warning: You can also use [Oracle JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) to build and run eclair, but we recommend you use Open JDK11. 

## Build
To build the project, simply run:
```shell
$ mvn install
```

#### Other build options

To skip all tests, run:
```shell
$ mvn install -DskipTests
```
To only build the `eclair-node` module
```shell
$ mvn install -pl eclair-node -am -DskipTests
```
Update README.md and add build.md 2017-03-17 19:07:29 +01:00			`# Building Eclair`

			`## Requirements`
Use OpenJDK 11 as default JDK (#846) * Upgrade to JDK11 Eclair can be built and used on Oracle JDK 1.8 or OpenJDK 11. JavaFX is now embedded in eclair-node-gui and does not need to be installed separately. * Install: update java download links OpenJDK 11 is now our recommendation. Tell users to download java from https://jdk.java.net/11 * README: Rewrite installation instructions 2019-02-21 15:11:44 +01:00			`- [OpenJDK 11](https://jdk.java.net/11/).`
Update scalatest and remove junit runner (#728) * updated to scalatest 3.0.5 * use scalatest runner instead of junit Output is far more readable, and makes console (incl. travis) reports actually usable. Turned off test logs as error reporting is enough to figure out what happens. The only downside is that we can't use junit's categories to group tests, like we did for docker related tests. We could use nested suites, but that seems to be overkill so I just removed the categories. Users will only have the possibility to either skip/run all tests. * update scala-maven-plugin to 3.4.2 NB: This requires maven 3.5.4, which means that we currently need to manually install maven on travis. Also updated Docker java version to 8u181 (8u171 for compiling). 2018-10-11 19:01:41 +02:00			`- [Maven](https://maven.apache.org/download.cgi) 3.5.4 or newer`
Mention Docker in our build instructions (fixes #669) (#685) Mention Docker in our build instructions (fixes #669) 2018-09-03 18:03:40 +02:00			`- [Docker](https://www.docker.com/) 18.03 or newer (optional) if you want to run all tests`
Update README.md and add build.md 2017-03-17 19:07:29 +01:00
Use OpenJDK 11 as default JDK (#846) * Upgrade to JDK11 Eclair can be built and used on Oracle JDK 1.8 or OpenJDK 11. JavaFX is now embedded in eclair-node-gui and does not need to be installed separately. * Install: update java download links OpenJDK 11 is now our recommendation. Tell users to download java from https://jdk.java.net/11 * README: Rewrite installation instructions 2019-02-21 15:11:44 +01:00			`:warning: You can also use [Oracle JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) to build and run eclair, but we recommend you use Open JDK11.`

Update README.md and add build.md 2017-03-17 19:07:29 +01:00			`## Build`
			`To build the project, simply run:`
			```shell
Added the maven command to build `eclair-node` only (#250) Also favouring `install` instead of `package` 2017-12-01 13:56:01 +01:00			`$ mvn install`
Update README.md and add build.md 2017-03-17 19:07:29 +01:00			```
Mention Docker in our build instructions (fixes #669) (#685) Mention Docker in our build instructions (fixes #669) 2018-09-03 18:03:40 +02:00
			`#### Other build options`

			`To skip all tests, run:`
Update README.md and add build.md 2017-03-17 19:07:29 +01:00			```shell
Added the maven command to build `eclair-node` only (#250) Also favouring `install` instead of `package` 2017-12-01 13:56:01 +01:00			`$ mvn install -DskipTests`
			```
			To only build the `eclair-node` module
			```shell
			`$ mvn install -pl eclair-node -am -DskipTests`
Update README.md and add build.md 2017-03-17 19:07:29 +01:00			```
Use OpenJDK 11 as default JDK (#846) * Upgrade to JDK11 Eclair can be built and used on Oracle JDK 1.8 or OpenJDK 11. JavaFX is now embedded in eclair-node-gui and does not need to be installed separately. * Install: update java download links OpenJDK 11 is now our recommendation. Tell users to download java from https://jdk.java.net/11 * README: Rewrite installation instructions 2019-02-21 15:11:44 +01:00