Skip to content

Commit

Permalink
Merge pull request #228 from loebse/build-doc
Browse files Browse the repository at this point in the history
Fixed some typos
  • Loading branch information
Ixam97 authored May 27, 2024
2 parents 73203da + fcf6181 commit 0524380
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Car Stats Viewer is divided in different build flavors depending on it's intende

<b>If you want to publish the app yourself as an internal test, only use the stable flavor from the master branch!

Branches other than `master` are considered to be in active developement and contain unfinished and instable features. Do not use these branches unless you konw what you are doing!</b>
Branches other than `master` are considered to be in active development and contain unfinished and unstable features. Do not use these branches unless you know what you are doing!</b>

It is not required to refactor all packages in the Android Studio project. This might lead to issues once updates get released. Instead, just rename the `applicationId` in the `build.gradle`. This will lead to a custom package name when building the app without affecting source code.
It is not required to refactor all packages in the Android Studio project. This might lead to issues once updates get released. Instead, just rename the `applicationId` in the `automotive\build.gradle`. This will lead to a custom package name when building the app without affecting source code.

Additionally, there will soon be a second flavor dimension to differentiate between the legacy version of Car Stats Viewer and the new version utilizing the Automotive Template Host. More on that when the time comes.

Expand All @@ -23,20 +23,20 @@ The app has the ABRP Telemetry API integrated as standard. For this to work an A

## Installing the App on a Car

It is not possible to sideload apps on a production car in the same maner it is possible for Android phones. Therefore it is necessary to deploy it via the Google Play Store. Since the app does not meet the requirements enforced by Google, it cannot be published outside of an internal test.
It is not possible to sideload apps on a production car in the same manner it is possible for Android phones. Therefore it is necessary to deploy it via the Google Play Store. Since the app does not meet the requirements enforced by Google, it cannot be published outside of an internal test.

To gain access to the Google Play Console to publish apps, you need to setup a developer account and pay a one time fee: https://support.google.com/googleplay/android-developer/answer/6112435

Within the Play Console, it is necessary to create a new formfactor for "Automotive OS". Otherwise, the App Bundle will be rejected when uploaded.
Within the Play Console, it is necessary to create a new form factor for "Automotive OS". Otherwise, the App Bundle will be rejected when uploaded.

Once setup, signed App Bundles can be uploaded as internal test releases.

## Create signed App Bundles

[Android Studio](https://developer.android.com/studio) is used to build the App. To be able to upload the App to the Google Play Store, a signed bundle is required: https://developer.android.com/studio/publish/app-signing

When building the bundle, select `stableRelease` as Build Variant. The created `.abb`-file can then be uploaded to the Play Console.
When building the bundle, select `stableRelease` as Build Variant. The created `.aab`-file can then be uploaded to the Play Console.

## Internal Testing

Internal tests are limited to a maximum of 100 testers. Their E-Mail-addresses used for the Google account in the car have to be added to the corresponding list. The testers can then opt-in via the link provided in the Testers-tab. After that the app has to be installed from the Play Store page from a webbrowser remotely, not via the built-in Play Store in the car since it is not listed publicly. The users need the link provided in the Play Console.
Internal tests are limited to a maximum of 100 testers. Their E-Mail-addresses used for the Google account in the car have to be added to the corresponding list. The testers can then opt-in via the link provided in the Testers-tab. After that the app has to be installed from the Play Store page from a web browser remotely, not via the built-in Play Store in the car since it is not listed publicly. The users need the link provided in the Play Console.

0 comments on commit 0524380

Please sign in to comment.