Skip to content

Commit b5c8969

Browse files
authored
Update README.md (#30)
Update README.md
2 parents ce94ef9 + d0ef35f commit b5c8969

File tree

2 files changed

+34
-2
lines changed

2 files changed

+34
-2
lines changed

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Platform specific README exists for [Android](android/) and [iOS](ios/).
1111

1212
# Setup
1313

14-
## Integration into a new Flutter app
14+
## Integration into a New Flutter App
1515

1616
### Android
1717

@@ -32,7 +32,7 @@ Let's create a simple app that integrates PSPDFKit and uses the Flutter pspdfkit
3232
```local.properties
3333
sdk.dir=/path/to/your/Android/sdk
3434
flutter.sdk=/path/to/your/flutter/sdk
35-
pspdfkit.password=YOUR_PASSWORD_GOES_HERE
35+
pspdfkit.password=YOUR_MAVEN_KEY_GOES_HERE
3636
flutter.buildMode=debug
3737
```
3838

@@ -369,3 +369,35 @@ showDocument() async {
369369
# Contributing
370370

371371
Please ensure [you signed our CLA](https://pspdfkit.com/guides/web/current/miscellaneous/contributing/) so we can accept your contributions.
372+
373+
# Troubleshooting
374+
375+
## Flutter Updates
376+
377+
To update Flutter to the latest version, all you have to do is run `flutter upgrade`.
378+
379+
## Flutter Configuration Problems
380+
381+
Among the tools provided by Flutter, there is `flutter doctor`, a very handy program that checks your system configuration for you and provides step-by-step actions to take in case of problems.
382+
383+
![Flutter doctor example](screenshots/flutter-doctor.png)
384+
385+
The verbose mode of flutter doctor is even more helpful; it prints out extensive information about the nature of an issue and how to fix it. To run the verbose mode, all you have to do is type `flutter doctor -d`.
386+
387+
### CocoaPods Conflicts With Asdf
388+
389+
If [asdf](https://github.com/asdf-vm/asdf) is installed in your machine it might create problems when running Cocoapods, and Flutter will erroneusly suggest to install CocoaPods via brew with `brew install cocoapods`. This won't work because for this specific configuration CocoaPods needs to be installed via [RubyGems](https://rubygems.org/). To fix this configuration issue just type `gem install cocoapods && pod setup`.
390+
391+
## Error When Running on Android: Cannot Find Symbol `PSPDFKit`
392+
393+
Verify that your Maven key has been correctly inserted in your `myapp/android/local.properties`
394+
395+
```local.properties
396+
sdk.dir=/path/to/your/Android/sdk
397+
flutter.sdk=/path/to/your/flutter/sdk
398+
pspdfkit.password=YOUR_MAVEN_KEY_GOES_HERE
399+
flutter.buildMode=debug
400+
```
401+
402+
Make sure that the Maven key has not been confused with the license key. The Maven key is generally shorter and for demo licenses it starts with `TRIAL-`.
403+

screenshots/flutter-doctor.png

207 KB
Loading

0 commit comments

Comments
 (0)