Browse Source

Improve readme

chat
Jonathan "Duke" Leto 5 years ago
parent
commit
70397f6a69
  1. 3
      .gitignore
  2. 54
      README.md

3
.gitignore

@ -57,3 +57,6 @@ freeline/
freeline_project_description.json
secrets.properties
# vim
*.sw?

54
README.md

@ -2,22 +2,25 @@
SilentDragon Android is an Android frontend for the desktop SilentDragon that lets you send and receive shielded payments from your mobile phone.
## Google Play
## When will it be in my favorite app store?
SOON
## Dev Download
### Running SilentDragon
You can also head over to the [Releases page](https://github.com/MyHush/SilentDragonAndroid/releases) to download an APK.
In order to let your Android phone connect to your desktop, you need to run the deskop [SilentDragon](https://github.com/MyHush/SilentDragon), and sync fully. This is not a full node
on your Android (your poor battery!). It's a remote control for your full node.
### Run SilentDragon
Thankfully this should only take a short time with a fast internet connection!
As the Hush network grows, it will take longer. As of Sept 2019, the blockchain
is about 900MB on disk.
In order to let your Android phone connect to your desktop, you need to run the deskop [SilentDragon](https://github.com/MyHush/SilentDragon), and sync fully.
After your node is synced, go to `Apps -> Connect Mobile App` to view the
connection QR Code, which you can scan from the Android App.
Thankfully this should only take a few minutes with a fast internet connection! As the Hush network grows, it will take longer.
## Dev Download
After your node is synced, go to `Apps -> Connect Mobile App` to view the connection QR Code, which you can scan from the Android App.
You can also head over to the [Releases page](https://github.com/MyHush/SilentDragonAndroid/releases) to download an APK. Please report bugs if you see any!
### Install the Android APK directly
@ -27,6 +30,7 @@ If you're installing the APK directly, you'll need to allow `Install from untrus
You can file issues in the [issues tab](https://github.com/MyHush/SilentDragonAndroid/issues).
We appreciate them! Please follow the Github issue template, when reasonable.
### Compiling from source
@ -42,11 +46,23 @@ On OS X:
touch ~/.android/repositories.cfg
sdkmanager --update
sdkmanager "platform-tools" "platforms;android-28"
gradle build
On Debian-based systems:
apt-get install android-sdk gradle
touch ~/.android/repositories.cfg
sdkmanager --update
sdkmanager "platform-tools" "platforms;android-28"
gradle build
## Release Build Process
The first time you create a release build you'll need to create two files. The release keystore is used for app signing and a properties file is used to store sensitive information about the keystore. These files should not be committed to git. Once you have both of these files you can create a release build for the Google Play Store.
The first time you create a release build you'll need to create two files. The
release keystore is used for app signing and a properties file is used to store
sensitive information about the keystore. These files should not be committed
to git. Once you have both of these files you can create a release build for
the Google Play Store.
### Creating a release keystore via CLI
@ -55,15 +71,18 @@ The `keytool` command can be used, for example:
keytool -genkey -alias silentdragon -keyalg RSA -keystore new.jks -dname "CN=Duke Leto, O=Hush" -storepass testing -keypass 123
### Creating a release keystore via GUI
* With Android Studio IDE open, on the system bar click Build -> Generate Signed Bundle/APK
* Select the APK option instead of the Bundle option
* On the next screen select app as the module and click "Create new"
* Set the Key Store Name to silent_dragon_keystore.jks and the path to that of the project, create a password for the keystore path, a Key alias, and a key password. The store password and key password should be the same. Fill out some basic organization information and click Ok.
* Set the Key Store Name to `silent_dragon_keystore.jks` and the path to that of the project, create a password for the keystore path, a Key alias, and a key password. The store password and key password should be the same. Fill out some basic organization information and click Ok.
* On the next screen make sure the build variant "release" is selected and click Finish.
### Creating a properties file
Within the projects main directory create a file secrets.properties The contents of the file are below and filled in with the release keystore alias, key password, and store password from when you created the release keystore.
Within the projects main directory create a file secrets.properties The
contents of the file are below and filled in with the release keystore alias,
key password, and store password from when you created the release keystore.
```
store_file_location=../silent_dragon_keystore.jks
@ -72,15 +91,22 @@ key_password=<key_password>
store_password=<store_password>
```
### Building a release APK
### Building a release APK for Google Play
Before creating each build you should increment the version code & version name in the build.gradle file. These must be incremented for each release otherwise the Play Store will reject the build.
Before creating each build you should increment the version code & version name
in the build.gradle file. These must be incremented for each release otherwise
the Play Store will reject the build.
To create a release build navigate to the project directory in terminal and run
`./gradlew clean assembleRelease`
This will produce an apk file in the following directory.
SilentDragonAndroid/app/build/output/apk/release/app-release.apk
SilentDragonAndroid/app/build/output/apk/release/app-release.apk
This build can be directly uploaded to Google Play.
### Building a release APK for F-Droid
...

Loading…
Cancel
Save