Skip to content

Commit dd45ebb

Browse files
authored
Merge pull request #369 from MarnixCroes/readme-v4-instructions
update README instructions to v4
2 parents 06f82f3 + 3c9ea17 commit dd45ebb

File tree

1 file changed

+12
-18
lines changed

1 file changed

+12
-18
lines changed

README.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@ Libbitcoin Build uses templates and XML data to generate build artifacts for the
99
See [MAINTAINED.md](MAINTAINED.md) for a list of artifacts maintained by this project.
1010

1111
* [![libbitcoin](https://github.com/libbitcoin/libbitcoin-system/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/libbitcoin/libbitcoin-system) [![Coverage Status](https://coveralls.io/repos/libbitcoin/libbitcoin-system/badge.svg)](https://coveralls.io/r/libbitcoin/libbitcoin-system) libbitcoin-system
12-
* [![libbitcoin-blockchain](https://github.com/libbitcoin/libbitcoin-blockchain/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/libbitcoin/libbitcoin-blockchain) [![Coverage Status](https://coveralls.io/repos/libbitcoin/libbitcoin-blockchain/badge.svg)](https://coveralls.io/r/libbitcoin/libbitcoin-blockchain) libbitcoin-blockchain
1312
* [![libbitcoin-client](https://github.com/libbitcoin/libbitcoin-client/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/libbitcoin/libbitcoin-client) [![Coverage Status](https://coveralls.io/repos/libbitcoin/libbitcoin-client/badge.svg)](https://coveralls.io/r/libbitcoin/libbitcoin-client) libbitcoin-client
14-
* [![libbitcoin-consensus](https://github.com/libbitcoin/libbitcoin-consensus/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/libbitcoin/libbitcoin-consensus) [![Coverage Status](https://coveralls.io/repos/libbitcoin/libbitcoin-consensus/badge.svg)](https://coveralls.io/r/libbitcoin/libbitcoin-consensus) libbitcoin-consensus
1513
* [![libbitcoin-database](https://github.com/libbitcoin/libbitcoin-database/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/libbitcoin/libbitcoin-database) [![Coverage Status](https://coveralls.io/repos/libbitcoin/libbitcoin-database/badge.svg)](https://coveralls.io/r/libbitcoin/libbitcoin-database) libbitcoin-database
1614
* [![libbitcoin-explorer](https://github.com/libbitcoin/libbitcoin-explorer/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/libbitcoin/libbitcoin-explorer) [![Coverage Status](https://coveralls.io/repos/libbitcoin/libbitcoin-explorer/badge.svg)](https://coveralls.io/r/libbitcoin/libbitcoin-explorer) libbitcoin-explorer
1715
* [![libbitcoin-network](https://github.com/libbitcoin/libbitcoin-network/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/libbitcoin/libbitcoin-network) [![Coverage Status](https://coveralls.io/repos/libbitcoin/libbitcoin-network/badge.svg)](https://coveralls.io/r/libbitcoin/libbitcoin-network) libbitcoin-network
@@ -55,13 +53,13 @@ builds/msvc/[edition]/[library].sln
5553

5654
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.
5755

58-
The build system has a dependency on [iMatix GSL](https://github.com/imatix/gsl), recently moved to the [ZeroMQ repository](https://github.com/zeromq/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](https://github.com/imatix/gsl/releases/download/NuGet-4.1.0.1/gsl.exe).
56+
The build system has a dependency on [ZeroMQ GSL](https://github.com/zeromq/gsl). There are Linux/macOS and Visual Studio builds of GSL. A recent version is recommended, and an executable . There is also a Windows single file executable available for [download](https://github.com/imatix/gsl/releases/download/NuGet-4.1.0.1/gsl.exe).
5957

6058
![Dependencies](https://raw.githubusercontent.com/libbitcoin/libbitcoin-build/master/img/dependencies.png)
6159

6260
### Quick Start
6361

64-
This is similar to the [.travis.yml](https://github.com/libbitcoin/libbitcoin-build/blob/master/.travis.yml) and is useful for local generation. In addition to `generate.sh` there is a `generate.cmd` for the native Windows environment.
62+
This is similar to the [.travis.yml](https://github.com/libbitcoin/libbitcoin-build/blob/master/.travis.yml) and is useful for local generation. In addition to `generate4.sh` there is a `generate4.cmd` for the native Windows environment.
6563

6664
#### Linux
6765
```
@@ -80,10 +78,8 @@ cd ../../
8078
8179
# Clone all libbitcoin repositories.
8280
git clone https://github.com/libbitcoin/libbitcoin-system.git
83-
git clone https://github.com/libbitcoin/libbitcoin-blockchain.git
8481
git clone https://github.com/libbitcoin/libbitcoin-build.git
8582
git clone https://github.com/libbitcoin/libbitcoin-client.git
86-
git clone https://github.com/libbitcoin/libbitcoin-consensus.git
8783
git clone https://github.com/libbitcoin/libbitcoin-database.git
8884
git clone https://github.com/libbitcoin/libbitcoin-explorer.git
8985
git clone https://github.com/libbitcoin/libbitcoin-network.git
@@ -94,35 +90,33 @@ git clone https://github.com/libbitcoin/libbitcoin-server.git
9490
# Run the libbitcoin-build generation script.
9591
# Newly generated build files are copied to the cloned repos.
9692
cd libbitcoin-build
97-
./generate.sh
93+
./generate4.sh
9894
```
9995
#### Windows
10096
```
101-
REM Create a top-level work_directory.
97+
# Create a top-level work_directory.
10298
set work_directory=%USERPROFILE%\work
10399
if not exist %work_directory% mkdir %work_directory%
104100
cd %work_directory%
105101
106-
REM Clone all libbitcoin repositories.
102+
# Clone all libbitcoin repositories.
107103
git clone https://github.com/libbitcoin/libbitcoin-system.git
108-
git clone https://github.com/libbitcoin/libbitcoin-blockchain.git
109104
git clone https://github.com/libbitcoin/libbitcoin-build.git
110105
git clone https://github.com/libbitcoin/libbitcoin-client.git
111-
git clone https://github.com/libbitcoin/libbitcoin-consensus.git
112106
git clone https://github.com/libbitcoin/libbitcoin-database.git
113107
git clone https://github.com/libbitcoin/libbitcoin-explorer.git
114108
git clone https://github.com/libbitcoin/libbitcoin-network.git
115109
git clone https://github.com/libbitcoin/libbitcoin-node.git
116110
git clone https://github.com/libbitcoin/libbitcoin-protocol.git
117111
git clone https://github.com/libbitcoin/libbitcoin-server.git
118112
119-
REM Download the gsl dependency manually from
120-
REM https://github.com/imatix/gsl/releases/download/NuGet-4.1.0.1/gsl.exe.
121-
REM Copy the gsl.exe manually to the libbitcoin-build folder in your work
122-
REM directory.
113+
# Download the gsl dependency manually from
114+
# https://github.com/imatix/gsl/releases/download/NuGet-4.1.0.1/gsl.exe.
115+
# Copy the gsl.exe manually to the libbitcoin-build folder in your work
116+
# directory.
123117
124-
REM Run the libbitcoin-build generation script.
125-
REM Newly generated build files are copied to the cloned repos.
118+
# Run the libbitcoin-build generation script.
119+
# Newly generated build files are copied to the cloned repos.
126120
cd libbitcoin-build
127-
./generate.cmd
121+
./generate4.cmd
128122
```

0 commit comments

Comments
 (0)