Skip to content

Commit 98e4193

Browse files
authored
Updated readme.
Updated readme with more details about requirements.
1 parent ca6dc4c commit 98e4193

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

example/README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,34 @@
22

33
This is a brief example of how to use the PSPDFKit with Flutter.
44

5+
# Requirements
6+
7+
## Android
8+
9+
- Android SDK 29.0.3 or later
10+
- PSPDFKit 6.5.2 for Android or later
11+
- Flutter 1.22.0-12.1.pre or later
12+
13+
## iOS
14+
15+
- Xcode 12
16+
- PSPDFKit 10.0.0 for iOS or later
17+
- Flutter 1.21.0-9.2.pre or later
18+
- CocoaPods 1.10.0.rc.1 or later (Update cocoapods with: `gem install cocoapods -v 1.10.0.rc.1`)
19+
520
# Running the Example Project
621

7-
1. Clone the repository `git clone https://github.com/PSPDFKit/pspdfkit-flutter.git`
22+
1. Before trying to run the project, please make sure that you are on the correct versions of all the tools mentioned above.
23+
2. Clone the repository `git clone https://github.com/PSPDFKit/pspdfkit-flutter.git`
824

9-
2. Create a local property file in `pspdfkit-flutter/example/android/local.properties` and specify the following properties:
25+
3. Create a local property file in `pspdfkit-flutter/example/android/local.properties` and specify the following properties:
1026

1127
```local.properties
1228
sdk.dir=/path/to/your/Android/sdk
1329
flutter.sdk=/path/to/your/flutter/sdk
1430
flutter.buildMode=debug
1531
```
1632

17-
3. cd `pspdfkit-flutter/example`
18-
4. Run `flutter emulators --launch <EMULATOR_ID>` to launch the desired emulator. Optionally, you can repeat this step to launch multiple emulators.
19-
5. The app is ready to start! Run `flutter run -d all` and the PSPDFKit Flutter example will be deployed on all your devices connected, both iOS and Android.
33+
4. cd `pspdfkit-flutter/example`
34+
5. Run `flutter emulators --launch <EMULATOR_ID>` to launch the desired emulator. Optionally, you can repeat this step to launch multiple emulators.
35+
6. The app is ready to start! Run `flutter run -d all` and the PSPDFKit Flutter example will be deployed on all your devices connected, both iOS and Android.

0 commit comments

Comments
 (0)