Skip to content

Commit bcd7f48

Browse files
Update build instructions
Signed-off-by: HashEngineering <hashengineeringsolutions@gmail.com>
1 parent b85b193 commit bcd7f48

File tree

2 files changed

+22
-7
lines changed

2 files changed

+22
-7
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,22 @@ The dashj library is a Java implementation of the Dash protocol, which allows it
2020
To get started, it is best to have the latest JDK and Maven installed. The HEAD of the `master` branch contains the latest development code and various production releases are provided on feature branches.
2121

2222
#### Building from the command line
23-
24-
To perform a full build use
23+
To initialize the repo after cloning it:
24+
```
25+
git submodule update --init --recursive
26+
```
27+
To perform a full build use (this includes the dashjbls shared library):
2528
```
2629
mvn clean package
2730
```
31+
To perform a full build without building the bls shared library and skip the test:
32+
```
33+
mvn clean package -Pno-build-bls -DskipTests
34+
```
35+
To perform a full build and install it in the local maven repository:
36+
```
37+
mvn clean install
38+
```
2839
You can also run
2940
```
3041
mvn site:site
@@ -37,6 +48,8 @@ The outputs are under the `target` directory.
3748

3849
Alternatively, just import the project using your IDE. [IntelliJ](http://www.jetbrains.com/idea/download/) has Maven integration built-in and has a free Community Edition. Simply use `File | Import Project` and locate the `pom.xml` in the root of the cloned project source tree.
3950

51+
The dashjbls library must still be built with `mvn`.
52+
4053
### Example applications
4154

4255
These are found in the `examples` module.

bls/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# dashj-bls
2-
DashJ Wrapper for bls-signatures
2+
DashJ-BLS is a wrapper for bls-signatures that requires a shared library called dashjbls.
33

4-
Building the Java Wrapper:
5-
6-
It builds automatically on Linux. On Windows Cmake (https://cmake.org/download/) and MinGW must be installed (http://mingw-w64.org/doku.php/download/mingw-builds)
4+
This library builds automatically on Linux with `mvn`. On Windows, Cmake (https://cmake.org/download/) and MinGW must be installed (http://mingw-w64.org/doku.php/download/mingw-builds)
75

6+
To initialize the repo after cloning it:
7+
```
8+
git submodule update --init --recursive
9+
```
810
##Windows (building through maven)
911
1. Install MinGW
1012
2. `mvn clean install` from a windows command prompt
@@ -14,7 +16,7 @@ It builds automatically on Linux. On Windows Cmake (https://cmake.org/download/
1416
2. Use the CMake GUI to configure and generate the build folder
1517
3. `cmake --build . -- -j 6` from the build folder using the Git Bash Shell
1618

17-
#Windows (buildig manually with CMake)
19+
#Windows (building manually with CMake)
1820
1) Install MinGW and CMake.
1921
2) Launch `Git Bash`
2022
3) `git submodule update --init --recursive`

0 commit comments

Comments
 (0)