BUILD.md

Building

lightning-kmp is a Kotlin Multiplatform library. It can run on many different platforms, including mobile devices (iOS and Android).

Requirements

On all platforms:

• Docker 18.03 or newer is required if you want to run all tests

For iOS, you need to have Xcode and Homebrew installed, and then:

brew install libtool
brew install gmp

Our tests use the ktor-client which depends on libcurl. On Linux, you need to install the libcurl4-gnutls-dev package:

sudo apt-get install libcurl4-gnutls-dev

Build

You should start by cloning the repository locally:

git clone [email protected]:ACINQ/lightning-kmp.git
cd lightning-kmp

To build the project library and install it locally, you can run:

./gradlew :build
./gradlew :publishToMavenLocal

To run all tests on all platforms:

./gradlew allTests

To run tests on a single platform, for example the JVM:

./gradlew jvmTest