|
1 | | -# Regula Document Reader (Android version) |
2 | | -`Advanced` folder contains the advanced sample project with almost all available features. |
| 1 | +# Document Reader SDK Advanced Sample Project (Android) |
3 | 2 |
|
4 | | -# Content |
5 | | -* [How to build the demo application](#how-to-build-the-demo-application) |
6 | | -* [Troubleshooting license issues](#troubleshooting-license-issues) |
| 3 | +* [Overview](#overview) |
| 4 | +* [Installation](#installation) |
| 5 | +* [Troubleshooting](#troubleshooting) |
7 | 6 | * [Documentation](#documentation) |
8 | | -* [Additional information](#additional-information) |
| 7 | +* [Demo Application](#demo-application) |
| 8 | +* [Technical Support](#technical-support) |
| 9 | +* [Business Enquiries](#business-enquiries) |
9 | 10 |
|
10 | | -## How to build the demo application |
11 | | -1. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git`. |
| 11 | +## Overview |
| 12 | + |
| 13 | +Sample project in Kotlin, demonstrating a variety of Document Reader SDK configuration and customization options. |
| 14 | + |
| 15 | +# Installation |
| 16 | + |
| 17 | +1. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git` |
12 | 18 | 2. Open the `Advanced/DocumentReader-Kotlin` project in an IDE. |
13 | | -3. If you use any mobile device (except 7310): |
14 | | -- visit our [Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps. |
15 | | -- copy the license file to the project: `Advanced/DocumentReader-Kotlin/app/src/main/assets/Regula/`. |
16 | | -- copy the database file db.dat from [Client Portal](https://client.regulaforensics.com/customer/databases) to the project: `Advanced/DocumentReader-Kotlin/app/src/main/assets/Regula/`. |
17 | | -4. Change the application ID to the one you have specified during the registration at [Client Portal](https://client.regulaforensics.com/). |
| 19 | +3. If you use any mobile device (except Regula 7310), add license and database files to the project: |
| 20 | + - Visit [Regula Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps. |
| 21 | + - Copy the license file to the project: `Advanced/DocumentReader-Kotlin/app/src/main/assets/Regula/` |
| 22 | + - Copy the database file `db.dat` from the [Client Portal](https://client.regulaforensics.com/customer/databases) to the project: `Advanced/DocumentReader-Kotlin/app/src/main/assets/Regula/` |
| 23 | +4. Change the application ID to the one you have specified during the registration at the [Client Portal](https://client.regulaforensics.com/). |
18 | 24 | 5. Run the project. |
19 | | -Note: Android Gradle plugin requires Java 11 to run |
| 25 | + |
| 26 | +**Note:** Android Gradle plugin requires Java 11 to run |
| 27 | + |
| 28 | +## Troubleshooting |
| 29 | + |
| 30 | +If you have issues with the license verification when running the application, check the following: |
20 | 31 |
|
21 | | -## Troubleshooting license issues |
22 | | -If you have issues with license verification when running the application, please verify that next is true: |
23 | 32 | 1. The OS, which you use, is specified in the license (Android). |
24 | 33 | 2. The application ID, which you use, is specified in the license. |
25 | 34 | 3. The license is valid (not expired). |
26 | 35 | 4. The date and time on the device, where you run the application, are valid. |
27 | 36 | 5. You use the latest release version of the Document Reader SDK. |
28 | | -6. You placed the license into the project. |
| 37 | +6. You placed the license into the project as described in the [Installation](#installation) section. |
29 | 38 |
|
30 | 39 | ## Documentation |
31 | | -The documentation on the SDK can be found [here](https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile?utm_source=github). |
32 | 40 |
|
33 | | -## Additional information |
34 | | -If you have any technical questions or suggestions, feel free to [contact ](mailto:[email protected]) us or create an issue [here ](https://github.com/regulaforensics/DocumentReader-Android/issues). |
| 41 | +<a target="_blank" href="https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/">Document Reader SDK Mobile Documentation</a> |
| 42 | + |
| 43 | +## Demo Application |
| 44 | + |
| 45 | +<a target="_blank" href="https://play.google.com/store/apps/details?id=com.regula.documentreader">Regula Document Reader Android Demo Application on Google Play</a> |
| 46 | + |
| 47 | +## Technical Support |
| 48 | + |
| 49 | +To submit a request to the Support Team, visit <a target="_blank" href="https://support.regulaforensics.com/hc/en-us/requests/new?utm_source=github">Regula Help Center</a>. |
| 50 | + |
| 51 | +## Business Enquiries |
35 | 52 |
|
36 | | -To use our SDK in your own app you have to [purchase](https://pipedrivewebforms.com/form/5f1d771cbe4f844a1f78f8a06fbf94361841159) a commercial license. |
| 53 | +To discuss business opportunities, fill the <a target="_blank" href="https://explore.regula.app/docs-support-request">Enquiry Form</a> and specify your scenarios, applications, and technical requirements. |
0 commit comments