airbnb / Showkase

🔦 Showkase is an annotation-processor based Android library that helps you organize, discover, search and visualize Jetpack Compose UI elements
https://medium.com/airbnb-engineering/introducing-showkase-a-library-to-organize-discover-and-visualize-your-jetpack-compose-elements-d5c34ef01095
Apache License 2.0
2.11k stars 107 forks source link

Docs: useKsp gradle flag doesn't seem to be relevant #251

Closed micHar closed 2 years ago

micHar commented 2 years ago

The README mentions that in order to use ksp, one should use a -PuseKsp=true flag in the gradle command that builds the app. I just checked and it doesn't seem to be necessary.

./gradlew sample:clean sample:build -i -PuseKsp=true

It is used by the showkase sample app, but it's misleading to include it in the installation instruction.

vinaygaba commented 2 years ago

Yeah you are right that I needed it only in the sample case since I've set up both the annotation processors there. The library itself isn't using the flag, just the sample is. I will remove it from the documentation. Thanks for flagging it!