Browse Source

Updated readme to describe how release documents are created.

chat
Mark Meister 5 years ago
parent
commit
87e07b49c9
  1. 20
      README.md

20
README.md

@ -29,12 +29,24 @@ You can file issues in the [issues tab](https://github.com/MyHush/SilentDragonAn
## Release Build Process
In order to build you'll need to obtain the following files and place them in the main directory.
* silent_dragon_keystore.jks
* secrets.properties
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.
These files contain sensitive information and should not be committed to git.
### Creating a release keystore
* 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.
* 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.
store_file_location=../silent_dragon_keystore.jks
key_alias=<alias>
key_password=<key_password>
store_password=<store_password>
### Building a release APK
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

Loading…
Cancel
Save