add readme.md

this contains build instructions on how to build this project
This commit is contained in:
Jeff Becker 2022-10-19 08:48:40 -04:00
parent d10bb853a6
commit 609466fac1
No known key found for this signature in database
GPG key ID: 025C02EE3A092F2D

37
readme.md Normal file
View file

@ -0,0 +1,37 @@
## build instructions
* install gomobile
```bash
go install golang.org/x/mobile/cmd/gomobile@latest
```
* build yggdrasil-go for android:
```
git clone https://github.com/yggdrasil-network/yggdrasil-go /tmp/yggdrasil-go
cd /tmp/yggdrasil-go
./contrib/mobile/build -a
```
* clone yggdrasil for android and copy over the built go library
```
git clone https://github.com/yggdrasil-network/yggdrasil-android /tmp/yggdrasil-android
mkdir /tmp/yggdrasil-android/app/libs
cp /tmp/yggdrasil-go/yggdrasil.aar /tmp/yggdrasil-android/app/libs/
```
* build yggdrasil-android
```
cd /tmp/yggdrasil-android
./gradew assemble
```
note: you will need to use jdk-11 as jdk-16 `"doesn't work" ™`
on debian/ubuntu you can set which jdk used with the `JAVA_HOME` env var:
```
export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64/
```