Skip to content

Commit 3a43afd

Browse files
committed
update installation instructions
1 parent 4010817 commit 3a43afd

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

INSTALLATION.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ If you want to do it manually by yourself, make sure all of following dependenci
1616
- automake
1717
- make
1818
- libtool
19-
- clang
19+
- clang (Build for java only)
2020

2121
### MacOS
2222
> Following packages can be installed via `brew`
@@ -30,34 +30,35 @@ If you want to do it manually by yourself, make sure all of following dependenci
3030
> Native libraries for this project includes `libwallycore` and the other jni wrapper libraries.
3131
You only need to build `libwallycore` once since it's not frequently changed but you have to rebuild the jni libraries each time there is any changes in the jni codes.
3232

33-
> For android building, `NDK_HOME="your/ndk/home"` is needed for each build command.
33+
> Environment variables is required for building native libraries. For android, `NDK_HOME="your/ndk/home"` is needed. For Java, you have to set`CC="your/clang"` before each build command.
34+
`JAVA_HOME="your/java/home"` also need for both.
3435

3536
Build `libwallycore` only
3637
```console
37-
$ JAVA_HOME="your/java/home" CC="clang" ./scripts/build-host.sh
38+
$ ./scripts/build-host.sh
3839
```
3940

4041
Build jni libraries only
4142
```console
42-
$ JAVA_HOME="your/java/home" CC="clang" ./scripts/build-jni.sh
43+
$ ./scripts/build-jni.sh
4344
```
4445

4546
Run following command for building all native libraries, includes `libwallycore` and jni libraries
4647
```console
47-
$ JAVA_HOME="your/java/home" CC="clang" ./scripts/build.sh
48+
$ ./scripts/build.sh
4849
```
4950

5051
## Android
5152
> Working directory: `/android`
5253
5354
### Testing
5455
```console
55-
$ ./gradlew clean connectedDebugAndroidTest
56+
$ ANDROID_SDK_ROOT="your/android-sdk/home" ./gradlew clean connectedDebugAndroidTest
5657
```
5758

5859
### Bundling
5960
```console
60-
$ ./gradlew clean assembleRelease
61+
$ ANDROID_SDK_ROOT="your/android-sdk/home" ./gradlew clean assembleRelease
6162
```
6263

6364
> The `app-release.aar` file would be found in `app/build/outputs/aar`. You can compile it as a library in your project.

0 commit comments

Comments
 (0)