sf_symbol_converter 1.0.0.alpha.1

# SFSymbol Icon Convertor Given a SVG icon with viewBox that respect [material icon principles](https://m3.material.io/styles/icons/designing-icons), generate appropriate SFSymbol. ## Longer rational Designers often use the **material guidelines** to produce icon. <img src="docs/images/material_viewbox.png" alt="Material Viewbox" width="200"> Inside this viewbox of 24x24px, there is a mandatory margin of 2px. The icon is supposed to respect a guideline. <img src="docs/images/material_guideline.png" alt="Material Guideline" width="200"> For instance theese icons respect material guidelines: <img src="docs/images/material_example1.png" alt="Material Example" width="150"> <img src="docs/images/material_example2.png" alt="Material Example" width="150"> <img src="docs/images/material_example3.png" alt="Material Example" width="150"> <img src="docs/images/material_example4.png" alt="Material Example" width="150"> More info here: https://m3.material.io/styles/icons/designing-icons --- On the other side, and while it is still possible to use `svg`, Apple pushes for the use of SfSymbol. SFSymbols have multiple benefits: - performance - ability to mix text and image in a proper way - ability to do bi (or multi) color icon <img src="docs/images/sfsymbol_bicolor.png" alt="Material Example" width="400"> More info here: - https://developer.apple.com/documentation/uikit/uiimage/creating_custom_symbol_images_for_your_app - https://developer.apple.com/design/human-interface-guidelines/sf-symbols It require the developper to take a template, and insert the icon inside, while respecting the size and the margin. <img src="docs/images/sfsymbol_template.png" alt="SfSymbol Template" width="650"> Since a few version, you can provide only three variations: - ultralight-S - regular-S - black-S And the system (UIKit, or SwiftUI) will interpolate the rest. <img src="docs/images/sfsymbol_interpolation.png" alt="SfSymbol Template" width="500"> We provide the small, but to respect the material system, you are supposed to use the `.medium` <img src="docs/images/sfsymbol_size.png" alt="SfSymbol Template" width="500"> ## Instalation and usage `gem install sf_symbol_converter` Then convert icon one by one: `sf_symbol_converter convert ./input.svg output.svg` Or batch convert: `sf_symbol_converter batch_convert ./input_dir/ ./output_dir`