mirror of
https://github.com/matomo-org/matomo-icons.git
synced 2024-09-19 17:03:45 +02:00
mention folder structure in README
This commit is contained in:
parent
a859f7e728
commit
8991835681
1 changed files with 20 additions and 0 deletions
20
README.md
20
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.
|
||||
|
|
Loading…
Reference in a new issue