Merge remote-tracking branch 'refs/remotes/origin/master' into playst…

…ore_test

README.md

@@ -10,12 +10,14 @@
 
 ## [Changes](/CHANGES.md)
 
+## [Building and installing Car Stats Viewer](/docs/BUILD.md)
+
 
 ## Installing the app on a car
 
 Currently the app is not available in the public Play Store. This is due to strict requirements by Google what kind of apps are allowed to be installed on cars. As of now the App is only available via internal test tracks which are limited to 100 users each. Here you can find a listing of all available Test Tracks: [Polestar Club](https://polestar.fans/t/carstatsviewer-informationen/15027)
 
-There are currently ongoing talks with Polestar to bring the app to a broader audience. But this will take some time and Polestar will most likely require some changes to make the app comply with their safety and usability standards.
+There are currently ongoing talks with Polestar to find ways of bringing the app to a broader audience.
 
 ## Using the webhook API
 

docs/BUILD.md

@@ -0,0 +1,40 @@
+# Building the App 
+
+## Build Flavors
+
+Car Stats Viewer is divided in different build flavors depending on it's intended use case:
+
+* Stable: Intended for general use by everyone. Only uses completed and mostly tested features.
+* Dev: Intended to only be used by developers while implementing new features. Many aspects are not stable for use and are only recommended for debugging.
+
+<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>
+
+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.
+
+## API Credentials
+
+The app has the ABRP Telemetry API integrated as standard. For this to work an API Key issued by Iternio is required. Iternio only wants one single API Key for each app, so please do not request you own API Key from them. Contact me directly if you want to enable ABRP Telemetry in your Fork and I will make sure to give you more details on how to implement the credentials. 
+
+<b>Credentials should never be published to GitHub!</b>
+
+## 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.
+
+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.
+
+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.
+
+## 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.