Updated Release notes (markdown)

TanelOrumaa 2021-10-10 23:41:16 +03:00
parent ef0dea8f98
commit a81b578983

@ -1,17 +1,7 @@
# Iteration 2 release notes # Iteration 2 release notes
### Requirements to use the application
* The smartphone's operating system must be Android 8.0 or newer
* The smartphone must support NFC technology and it must be enabled
* The user must have an Estonian ID card with NFC capability (issued since 2018)
_Knowledge of Estonian might be useful as the application is in Estonian language at the moment. The English language support will be added during the iteration 3. If one does not understand Estonian then the guide at the bottom of the release notes might be useful._ For guidance how to run the project look at [Readme](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/edit/main/README.md)
### Installing the application on the phone
The first option is to open the MobileAuthApp folder of the project on the Android Studio and use the smartphone instead of an emulator (the application does not work with emulators because real ID card has to be scanned, which an emulator can not do) to run the application. This way the application gets installed on the phone automatically.
More information about using real devices with Android studio: https://developer.android.com/studio/run/device
The second and more reliable option is to get the .apk that is generated under the Artifacts of GitHub Actions when the project is built. Download the .apk file and move it to the smartphone and install it (phone permissions might have to be changed because it is not installed through Google Play). After the application has been installed it should open as any other application.
APK for iteration 2 release can be downloaded from here: https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/actions/runs/1326585501 APK for iteration 2 release can be downloaded from here: https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/actions/runs/1326585501
More info about installing third party applications on the Android phones: https://www.androidauthority.com/how-to-install-apks-31494/ More info about installing third party applications on the Android phones: https://www.androidauthority.com/how-to-install-apks-31494/