From a77e4161c42c48dff9daf183aa18d48bfcdb2b04 Mon Sep 17 00:00:00 2001 From: 8go Date: Thu, 6 Aug 2020 16:16:04 +0000 Subject: [PATCH] Eclair: English touch ups, commas - commas - reorg of sentences - "Check to..." sentence is copy-paste from above, changed it slightly to avoid repetition - OK, Eclair is uppercase, but here we refer to a directory which is lowercase, so "eclair" (just because it is the lowercase name of the dir) - etc --- node_client.asciidoc | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/node_client.asciidoc b/node_client.asciidoc index 296778e..34566dd 100644 --- a/node_client.asciidoc +++ b/node_client.asciidoc @@ -831,19 +831,19 @@ In the next section we will also look at how to download and compile Eclair dire ==== Installing Eclair from source code -In this section we will build Eclair from scratch. Eclair is written in the Scala programming language, which is compiled using the Java compiler. To run Eclair, we first need to install Java and its build tools. We will be following the instructions found on the Eclair project in the BUILD.md document: +In this section we will build Eclair from scratch. Eclair is written in the Scala programming language which is compiled using the Java compiler. To run Eclair, we first need to install Java and its build tools. We will be following the instructions found in the BUILD.md document of the Eclair project: https://github.com/ACINQ/eclair/blob/master/BUILD.md -The Java compiler we need is part of OpenJDK 11. We will also need a buid framework called Maven, version 3.6.0 or above. +The required Java compiler is part of OpenJDK 11. We will also need a buid framework called Maven, version 3.6.0 or above. -On a Debian/Ubuntu Linux system, we can use the apt commands below to install OpenJDK11 and Maven: +On a Debian/Ubuntu Linux system we can use the +apt+ command to install both OpenJDK11 and Maven as shown below: ---- $ sudo apt install -y openjdk-11-jdk maven ---- -Check that you have the correct version installed and ready to use by running: +Verify that you have the correct version installed by running: ---- $ javac -version @@ -859,7 +859,7 @@ We have OpenJDK 11.0.7 and Maven 3.6.1, so we're ready. ==== Copying the Eclair source code -The source code for Eclair is on Github. The +git clone+ command can create a local copy for us. Let's switch to our home directory and run it there: +The source code for Eclair is on Github. The +git clone+ command can create a local copy for us. Let's change to our home directory and run it there: ---- $ cd @@ -867,11 +867,11 @@ $ git clone https://github.com/ACINQ/eclair.git ---- -Once +git clone+ finishes, you will have a sub-directory +Eclair+ containing the source code for the Eclair server. +Once +git clone+ finishes you will have a sub-directory +eclair+ containing the source code for the Eclair server. ==== Compiling the Eclair source code -Eclair uses the +Maven+ build system. To build the project, we change directory to Eclair's source code and then use +mvn package+, like this: +Eclair uses the +Maven+ build system. To build the project we change the working directory to Eclair's source code and then use +mvn package+ like this: ---- $ cd eclair @@ -904,11 +904,11 @@ $ mvn package ---- -After several minutes, the Eclair package will be built. You will find the Eclair server node under +eclair-node/target+, packaged as a zip file. Unzip and run it, by following the instructions here: +After several minutes the build of the Eclair package will complete. You will find the Eclair server node under +eclair-node/target+, packaged as a zip file. Unzip and run it, by following the instructions found here: https://github.com/ACINQ/eclair#installing-eclair -Congratulations, you have built Eclair from source and you are ready to code, test, bug fix, and contribute to this project! +Congratulations! You have built Eclair from source and you are ready to code, test, fix bugs, and contribute to this project! === Building a complete network of diverse Lightning Nodes