doc: add emulator usage instructions into the readme
Compare changes
+ 29
− 4
@@ -13,6 +14,7 @@ You can get the pre-built app from either [Google Play Store][google-play-link]
@@ -13,6 +14,7 @@ You can get the pre-built app from either [Google Play Store][google-play-link]
@@ -81,7 +83,24 @@ cmake --build build
@@ -81,7 +83,24 @@ cmake --build build
Upload the final APK file to your Android device and run. Then follow the instructions within the app.
Android emulators run behind a [virtual router](https://developer.android.com/studio/run/emulator-networking) and network address translation (NAT) so they can't be accessed directly from the host machine. There is one TCP port required to be forwarded in between that virtual router and the host machine so that Qt Design Studio can communicate with the application.
@@ -94,11 +113,11 @@ npm i -g xunit-viewer
@@ -94,11 +113,11 @@ npm i -g xunit-viewer
It'll create a `report.html` file that can be opened in a web browser. For more information about `xunit-viewer` please visit the [GitHub repo](https://github.com/lukejpreston/xunit-viewer).
[android:versionCode](https://developer.android.com/guide/topics/manifest/manifest-element#vcode) is an integer value that should be incremented for each new release and it's required by Google Play Store. It's used to determine if the app should be updated or not.
During the development this value can be set to any arbitrary integer. But for the release it should be incremented. The value can be controlled by setting the CMake variable called `GOOGLE_PLAY_APP_VERSION` during the CMake configuration step.
@@ -108,7 +127,7 @@ It's easy for an individual developer to forget to increment it before the relea
@@ -108,7 +127,7 @@ It's easy for an individual developer to forget to increment it before the relea
The value `11` is coming from the times where `GOOGLE_PLAY_APP_VERSION` was increased without creating a tag, so we have an offset in between the tag count and the actual value. From now on the value should be incremented by creating a new tag.
There's no `AndroidManifest.xml` file in the repository. `AndroidManifest.xml.in` file is used to generate the `AndroidManifest.xml` file during the configuration step. The `versionCode` value is set to the `GOOGLE_PLAY_APP_VERSION` and the `versionName` value is set to the output of the `git describe --always --tags` command.
There's no `AndroidManifest.xml` file in the repository. `AndroidManifest.xml.in` file is used to generate the `AndroidManifest.xml` file during the configuration step. The `versionCode` value is set to the `GOOGLE_PLAY_APP_VERSION` and the `versionName` value is set to the output of the `git describe --always --tags` command.
@@ -126,3 +145,9 @@ Both values can be seen in the `AndroidManifest.xml` file after the CMake config
@@ -126,3 +145,9 @@ Both values can be seen in the `AndroidManifest.xml` file after the CMake config