mirrors/eclair
1
0
Fork 0
mirror of https://github.com/ACINQ/eclair.git synced 2025-02-23 22:46:44 +01:00
Code Issues Projects Releases Wiki Activity
eclair/BUILD.md
Bastien Teinturier b9698f2230
Documentation update (#1092) 
* Fix README style warnings
* Add documentation links to the wiki
* Update build instructions.
2019-07-31 13:35:26 +00:00

1.5 KiB
Raw Blame History

Building Eclair

Requirements

⚠️ You can also use Oracle JDK 1.8 to build and run eclair, but we recommend you use OpenJDK 11.

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:

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