From 3048dfb06353b7cf668a90d0e80719ca9c4ed039 Mon Sep 17 00:00:00 2001 From: Max Barraclough Date: Sun, 20 Feb 2022 10:11:05 +0000 Subject: [PATCH 1/4] Improve README files * Update README to reference README-hacking for build instructions * Update README-hacking re. building lightning * Mention that the disassembler feature is optional and introduces additional dependencies * Provide an 'apt-get' command, tested on Ubuntu, to install all dependencies needed to build Lightning with its disassembler Signed-off-by: Max Barraclough --- README | 2 ++ README-hacking | 10 ++++++++++ 2 files changed, 12 insertions(+) diff --git a/README b/README index ae36ea5..7e3df42 100644 --- a/README +++ b/README @@ -1,3 +1,5 @@ GNU lightning is a library to aid in making portable programs that compile assembly code at run time. For more information, look at the info documentation. + +For help building lightning, see README-hacking. diff --git a/README-hacking b/README-hacking index 285f3c9..cc61598 100644 --- a/README-hacking +++ b/README-hacking @@ -22,6 +22,12 @@ for Debian-based systems such as Ubuntu: ** Building +If you intend to do development work with lightning, it's useful to build +lightning with its disassembler feature enabled. This optional feature +requires additional dependencies. On Ubuntu, this command should work: + + $ sudo apt-get install binutils-dev libiberty-dev zlib1g-dev + After getting the git sources, and installing the tools above, you can run $ ./bootstrap @@ -38,6 +44,10 @@ should output no difference. After that first time, running make should suffice. +To install lightning: + + $ sudo make install + ** Gnulib This distribution also uses Gnulib (https://www.gnu.org/software/gnulib) to -- 2.32.0