mirror of https://github.com/ACINQ/eclair.git synced 2024-11-19 18:10:42 +01:00

Pierre-Marie Padiou 8ee53bc97d

We already have Java 7 (for Android) and Java 11. Supporting Java 8
would require crossbuilding, which we are not doing (two recent PRs
broke the build on Java 8).

2019-09-16 11:04:10 +02:00

1.3 KiB

Raw Blame History

Building Eclair

Requirements

OpenJDK 11.
Maven 3.6.0 or newer
Docker 18.03 or newer (optional) if you want to run all tests

Build

To build the project and run the tests, simply run:

mvn install

Other build options

To skip all tests, run:

mvn install -DskipTests

To only build the eclair-node module, run:

mvn install -pl eclair-node -am -DskipTests

To run the tests, run:

mvn test

To run tests for a specific class, run:

mvn test -Dsuites=*<TestClassName>

Build the API documentation

Slate

The API doc is generated via slate and hosted on github pages. To make a change and update the doc follow the steps:

git checkout slate-doc
Install your local dependencies for slate, more info here
Edit source/index.html.md and save your changes.
Commit all the changes to git, before deploying the repo should be clean.
Push your commit to remote.
Run ./deploy.sh
Wait a few minutes and the doc should be updated at https://acinq.github.io/eclair

1.3 KiB Raw Blame History