From 8991835681867de1d069fe3383419fb99b3835d7 Mon Sep 17 00:00:00 2001 From: Lukas Winkler Date: Tue, 9 May 2017 08:43:57 +0200 Subject: [PATCH] mention folder structure in README --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 509d3af..ce691e6 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,23 @@ This reposistory provides the source files for the icons in [piwik](https://gith ## Contributing An icon is missing or you have a better one? Create a [new issue](https://github.com/piwik/piwik-icons/issues/new) or, even better, open a pull request. + +All source files except those in `devices`, `flags`, `searchEngines` and `socials` need to have a second file called `iconname.ext.source` that mentions where the image is from. + +### Naming conventions + +| icon type | example | possible names | +| --------- | ------- | ----------- | +|brand|*Apple*| *Device detection* in Piwik Administration page| +|browsers|*FF*|https://github.com/piwik/device-detector/blob/master/Parser/Client/Browser.php#L29 | +|devices|*smartphone*| *Device detection* in Piwik Administration page| +|flags|*at*| all except *un* and *gb-** | +|os|*WIN*|https://github.com/piwik/device-detector/blob/master/Parser/OperatingSystem.php#L30 | +|plugins|*flash*|https://github.com/piwik/piwik/blob/3.x-dev/plugins/DevicePlugins/Visitor.php#L26 | +|searchEngines|*google.com*|https://github.com/piwik/searchengine-and-social-list/blob/master/SearchEngines.yml | +|SEO|*bing.com*|https://github.com/piwik/piwik/tree/3.x-dev/plugins/SEO | +|socials|*facebook.com*|https://github.com/piwik/searchengine-and-social-list/blob/master/Socials.yml | + +### File Formats + +Ideally all source files should be SVGs or high resolution (>100px) PNGs. As this is not always possible, JPGs, GIFs and (even multiresolution) ICOs are supported.