2017-03-17 19:07:29 +01:00
|
|
|
# Building Eclair
|
|
|
|
|
|
|
|
|
|
## Requirements
|
2018-03-20 16:40:21 +01:00
|
|
|
- [Java Development Kit](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) 1.8u161 or newer
|
2018-10-11 19:01:41 +02:00
|
|
|
- [Maven](https://maven.apache.org/download.cgi) 3.5.4 or newer
|
2017-03-17 19:07:29 +01:00
|
|
|
- [Inno Setup](http://www.jrsoftware.org/isdl.php) 5.5.9 (optional, if you want to generate the windows installer)
|
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
|
2017-03-17 19:07:29 +01:00
|
|
|
|
|
|
|
|
## Build
|
|
|
|
|
To build the project, simply run:
|
|
|
|
|
```shell
|
2017-12-01 13:56:01 +01:00
|
|
|
$ mvn install
|
2017-03-17 19:07:29 +01:00
|
|
|
```
|
2018-09-03 18:03:40 +02:00
|
|
|
|
|
|
|
|
#### Other build options
|
|
|
|
|
|
|
|
|
|
To skip all tests, run:
|
2017-03-17 19:07:29 +01:00
|
|
|
```shell
|
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
|
2017-03-17 19:07:29 +01:00
|
|
|
```
|
2017-08-23 19:28:18 +02:00
|
|
|
To generate the windows installer along with the build, run the following command:
|
|
|
|
|
```shell
|
2017-12-01 13:56:01 +01:00
|
|
|
$ mvn install -DskipTests -Pinstaller
|
2017-08-23 19:28:18 +02:00
|
|
|
```
|
|
|
|
|
The generated installer will be located in `eclair-node-gui/target/jfx/installer`
|
