follmann / favicon_maker

Create favicon files in various sizes from a base image for ruby projects
MIT License
70 stars 7 forks source link

I don't understand the documentation #18

Closed marvindanig closed 9 years ago

marvindanig commented 9 years ago

I included gem 'favicon_maker' on my Gemfile, what do I do next? Where does the code block with 'FaviconMaker.generate' go and how to include the generated icons in the layout?

follmann commented 9 years ago

Well it depends. This gem has a sister project called middleman-favicon-maker that effortlessly integrates with the Middleman framework, that I developed it for. If you use Rails you'd probably go the route of either generating the icons via a rake task, therefore placing the generate block in there. Or you make the icon generation part of your deployment script. Here is an example from the old instructions (only meant to jump start you), it is untested and probably not up-to-date: https://github.com/follmann/favicon_maker/blob/master/OLD_INSTRUCTIONS.md

Regarding including the icons in your layout. You don't have to do that per se. But if you want, this will help you: https://github.com/follmann/middleman-favicon-maker#markup-meta-links

marvindanig commented 9 years ago

Hey follman, thanks for your answer! I've this rails app that's going to have a logo that's not gonna change over time. So I guess a rake task would be enough I wouldn't need it on my deploy script. I'm not using middleman but I'm hoping that this gem will work without it.

I was quite shocked when I learned that we don't need to add each of the icon_sizes individually on our layout because iOS takes care of it automatically; but then we also have a bulk of world on Android/others that do not follow suit... So no donut for web developers I will add the code block explicitly. :(

Thanks, let me try the gem and come back on another thread if I need help.