search

unoplatform / uno.resizetizer

The home for Uno.Resizetizer, an image resizting tooling for Uno Platform apps
https://platform.uno
Other
15 stars 6 forks source link

[Doc] Add explanation of `Svg` folders in README or `SharedAssets.md` #262

Open MartinZikmund opened 1 month ago

MartinZikmund commented 1 month ago

What would you like to be added:

The fact that folders named Svg are ignored by Resizetizer by default should be clearly mentioned in the default generated project as part of a README or SharedAssets.md

~A guidance or even default folder in the template where .svg would be ignored by Resizetizer.~

~Reasoning behind this is that in WinUI .svgs are just content files by default. Currently .svgs in our case are resized by default, which is a discrepancy.~

~Maybe it would make sense to include a folder like Assets/Svg in the project template with a README that says that .svg in that location is not resized~

dansiegel commented 1 month ago

@MartinZikmund this sounds like it has nothing to do with Resizetizer. By default Resizetizer doesn't do anything. The SDK does provide default includes. By default the SDK excludes adding UnoImage's in $(AssetsFolder)\**\Svg\*.svg which would seem to already be doing what you're asking for.

MartinZikmund commented 1 month ago

Ah, in that case I this will mainly be docs I guess (maybe I have missed this somewhere, but if not yet documented, that would be useful). And having such folder with a README in template could be nice as well, for out of the box clarity

agneszitte commented 1 month ago

@MartinZikmund he is the current doc https://platform.uno/docs/articles/features/svg.html?tabs=singleproject#how-to-use-svg image Let me know if you think we should make things clearer as needed.

And I agree with you @MartinZikmund, a default README (mentioning details about assets, resizetizer, svg,...) in the template would be helpful as right now we currently only have the SharedAssets.md with these details: image cc @jeromelaban

MartinZikmund commented 1 month ago

Great that we have docs 👍

agneszitte commented 1 month ago

@jeromelaban, @MartinZikmund, @dansiegel
I think we should open a proper issue to add a default README (mentioning details + links for the doc about assets, resizetizer, SVG,...) in the template. It would be helpful as right now we currently only have the SharedAssets.md with these details: image