-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix small issue in build script, add README.md (#3)
Signed-off-by: Ben Burns <[email protected]>
- Loading branch information
1 parent
a2a4eae
commit e417cd4
Showing
2 changed files
with
35 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Besu Native | ||
|
||
This repository contains scripts and tooling that is used to build and package the native libraries used by Hyperledger Besu. | ||
|
||
## Prerequisites | ||
|
||
### Linux | ||
|
||
You'll need to be sure that gcc, make, autoconf, automake, and libtool are installed. If you are building on Ubuntu or Debian, the following command will install these dependencies for you: | ||
|
||
``` | ||
sudo apt-get install build-essential automake autoconf libtool | ||
``` | ||
|
||
### OS X | ||
|
||
You'll need to be sure that XCode Command Line Tools, make, autoconf, automake, and libtool are installed. The easiest way to do this is to install [Homebrew](https://brew.sh/), and then run the following command. Note that installing Homebrew will automatically install the XCode command line tools. | ||
|
||
``` | ||
brew install autoconf automake libtool | ||
``` | ||
|
||
### Windows | ||
|
||
TBD | ||
|
||
## Building | ||
|
||
1. This repository builds native libraries from source that is included as git submodules. To be sure that you have cloned those submodules into the appropriate locations, run `git submodule update` | ||
2. The build steps are entirely contained within the `build.sh` script at the repository root. Simply run this script, and all of the native modules contained herin will be configured with the correct build options for Hyperledger Besu, and built. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters