Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Android documentation "quick start example" doesn't work as written #3159

Open
SomeoneElseOSM opened this issue Jan 20, 2025 · 1 comment
Open
Labels
android documentation Improvements or additions to documentation

Comments

@SomeoneElseOSM
Copy link

MapLibre Android Version

n/a

Android SDK Version

n/a

Device

n/a

What happened?

Find front page of documentation
https://maplibre.org/maplibre-native/android/examples/

Click link below "Learn how to include MapLibre Android in your project"
https://maplibre.org/maplibre-native/android/examples/getting-started/

That says "Add bintray Maven repositories to your project-level Gradle file (usually //build.gradle)." and there's some code. There's a "copy to clipboard" option which suggests that that code can literally just be copied in.

Steps to reproduce

Unfortunately, it can't. It contains "..." which presumably means that it needs to be merged with some existing code in some way, but what or how is not described.

The actual contents of the top-level build.gradle (and whether it exists at all) will depend on what sort of project was created in Android Studio as the "New Project" and what was selected on subsequent screens for e.g. language and build system.

Renderer

No response

Relevant log output

n/a

Additional context

No response

@louwers
Copy link
Collaborator

louwers commented Jan 20, 2025

Thanks for the feedback.

I agree we should make the Getting Started guide as approachable as possible.

@louwers louwers added the documentation Improvements or additions to documentation label Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
android documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants