Improve Android doc (triplets, usage with cmake and prefab)#11264
Improve Android doc (triplets, usage with cmake and prefab)#11264strega-nil merged 9 commits intomicrosoft:masterfrom
Conversation
|
@pthom @strega-nil looks good to me |
|
@atkawa7 : if you have a few minutes, would you mind giving me some help on this pr: #11269 My issue is that I now can built a prefab package, but I do not know how to consume it (and thus test it). As a newbie to android development, the prefab doc was not that helpful for this. |
|
@pthom I forgot another option which shows examples on how to consume it. Add this option ./vcpkg export --triplet arm64-android jsoncpp --prefab --prefab-maven --prefab-debugOutput Note: prefab packages are supported on Android Studio 4+ If you have Android 3.6 you might need to install android 4.1 Preview |
|
@pthom checkout the following project that I created to consume the packages created https://github.com/atkawa7/prefab-vpkg-integration-sample |
Following additional informations given by @atkawa7 at microsoft#11264 * Link to android.md * Update the prefab usage instructions: "vcpkg install" the 4 archs before exporting a prefab * added --prefab-debug flag * added gradle integration info * reviewed the prefab output directory structure (from a dump of an actual export)
|
I made some changes, and added an example + android.md file. @atkawa7 could you please have a look at |
|
@pthom looks good to me |
|
Please poke me when you think the documentation is ready to merge; I don't know anything about android, and so I'm just going to trust your judgement :) |
|
@strega-nil I think the documentation in its current form is good. I think @pthom addressed issues that new users might come across when consuming android archive packages. I don't know if there is still anything to be added @pthom. I am sure as more issues related to android come up we will continue to improve the docs and address concerns users might have |
….cmake
Usage:
1. Main CMakeLists:
if (VCPKG_TARGET_ANDROID)
include("cmake/vcpkg_android.cmake")
endif()
2. cmake invocation:
cmake .. -DVCPKG_TARGET_ANDROID=ON -DANDROID_ABI=armeabi-v7a
|
I added a second example It provides a script vcpkg_android.cmake The usage is even simpler:
if (VCPKG_TARGET_ANDROID)
include("cmake/vcpkg_android.cmake")
endif()
cmake .. -DVCPKG_TARGET_ANDROID=ON -DANDROID_ABI=armeabi-v7aI have successfuly tested on two vanillla installations of vcpkg under linux and MacOS. @atkawa7 @strega-nil : if this looks good to you, the PR is ok on my side too |
|
Alright, awesome! Thanks everyone, and @pthom especially. Y'all make this project so good! |
Describe your PR
Improve Android prefab and triplet doc
Add a very minimal example showcasing the use of vcpkg + cmake + android
Add docs/users/android.md. This file provides:
Improve the android prefab doc
provides links to android.md inside docs/triplet.md
provides link to android.md inside docs/index.md
What does your PR fix?
This PR can may be considered as a fix for two issues that arise because of incomplete doc
Which triplets are supported/not supported? Have you updated the CI baseline?
Not applicable, this is doc only
Does your PR follow the maintainer guide?
Yes