/libbitcoin-build

Libbitcoin Build System

Primary LanguageM4OtherNOASSERTION

Build Status

Libbitcoin Build

Libbitcoin Build System

Libbitcoin Build uses templates and XML data to generate build artifacts for the following libbitcoin libraries.

  • libbitcoin Coverage Status libbitcoin
  • libbitcoin-blockchain Coverage Status libbitcoin-blockchain
  • libbitcoin-client Coverage Status libbitcoin-client
  • libbitcoin-consensus Coverage Status libbitcoin-consensus
  • libbitcoin-database Coverage Status libbitcoin-database
  • libbitcoin-explorer Coverage Status libbitcoin-explorer
  • libbitcoin-network Coverage Status libbitcoin-network
  • libbitcoin-node Coverage Status libbitcoin-node
  • libbitcoin-protocol Coverage Status libbitcoin-protocol
  • libbitcoin-server Coverage Status libbitcoin-server

Notes on Badges

  • libitcoin-client coverage does not reflect the effect of libitcoin-explorer network tests.
  • libitcoin-explorer coverage does not reflect the effect of network tests.
  • libitcoin-network coverage does not reflect the effect of network tests.
  • Current converage is inflated by the fact that only files with some level of coverage are counted.

The artifacts generated for each library are as follows. Package names coincide with libbitcoin repository names.

.travis.yml
autogen.sh
configure.ac
install.sh
[library].pc.in
[library]_test_runner.sh
Makefile.am
include/bitcoin/[library].hpp
include/bitcoin/[library]/version.hpp

These artifacts are merged into their respective repositories by libbitcoin maintainers. There is no need to build libbitcoin-build if you are not a maintainer in the process of applying a build configuration change.

The build system has a dependency on iMatix GSL. There are Linux/OSX and Visual Studio builds of GSL. A recent version is recommended. There is also a Windows single file executable available for download.

Dependencies

Quick Start

This is similar to the .travis.yml and is useful for local generation. In addition to generate.sh there is a generate.bat for the native Windows environment.

# Create a top-level work_directory.
work_directory=$HOME/work
mkdir -p $work_directory
cd $work_directory

# Clone, build and install the gsl dependency.
git clone https://github.com/imatix/gsl.git
cd gsl/src
make && sudo make install
cd ../../

# Clone all libbitcoin repositories.
git clone https://github.com/libbitcoin/libbitcoin.git
git clone https://github.com/libbitcoin/libbitcoin-blockchain.git
git clone https://github.com/libbitcoin/libbitcoin-build.git
git clone https://github.com/libbitcoin/libbitcoin-client.git
git clone https://github.com/libbitcoin/libbitcoin-consensus.git
git clone https://github.com/libbitcoin/libbitcoin-database.git
git clone https://github.com/libbitcoin/libbitcoin-explorer.git
git clone https://github.com/libbitcoin/libbitcoin-network.git
git clone https://github.com/libbitcoin/libbitcoin-node.git
git clone https://github.com/libbitcoin/libbitcoin-protocol.git
git clone https://github.com/libbitcoin/libbitcoin-server.git

# Run the libbitcoin-build generation script.
# Newly generated build files are copied to the cloned repos.
cd libbitcoin-build
./generate.sh