search

coil-kt / coil

Image loading for Android and Compose Multiplatform.
https://coil-kt.github.io/coil/
Apache License 2.0
10.83k stars 664 forks source link

docs: add important usage note for Compose Multiplatform #2678

Closed AungThiha closed 1 week ago

AungThiha commented 1 week ago

To help new users of coil in Compose Multiplatform find the guide easier. This can help new users avoid below problem I had.

When I first tried, I used okhttp and was stuck for a while until I carefully read the error logs and found something about compatibility issue with one of the iOS CPU architecture. Then, I started googling and found nothing. Eventually, I carefully read the documentation. Only then, I found what's wrong.

Anecdote aside, the text I added is basically a word for word copy-paste from the official document. The only thing I added is > **⚠️ Important:**

colinrtwhite commented 1 week ago

@AungThiha This is already mentioned at the top of the getting started docs here. I'd prefer to keep the quickstart readme as simple as possible and avoid adding notes/warnings as it adds mental load.

AungThiha commented 1 week ago

@colinrtwhite understood but it's not in the readme, which made me confused. If you'd like to keep readme simple, I'd like to request the removal of quickstart from readme and only link it to the docs. I can make a PR for that if you're alright with that request.