edent-gh/SuperTinyIcons
1
0
Fork 0
forked from edent/SuperTinyIcons
Code Pull Requests Activity

Merge branch 'master' of github.com:edent/SuperTinyIcons

Browse Source
This commit is contained in:
Terence Eden
2024-09-10 16:04:11 +01:00
parent 0b1bb102ec bb9e3ed66b
commit 5e403fee56
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.md
View File

@@ -4,9 +4,9 @@ Thanks for submitting or fixing an icon! Here is a helpful guide to what you nee
Additionally, you can do these helpful things if you have time: Additionally, you can do these helpful things if you have time:
- [ ] Edit Readme
- [ ] Add reference image - [ ] Add reference image
- [ ] Add official brand guidelines URl - [ ] Add official brand guidelines URl
- [ ] Update README using the python script
- [ ] Android Image - [ ] Android Image
## New File ## New File
@@ -47,15 +47,7 @@ This is the standard guideline. Use this to help with sizing your icons and they
- **Yellow** is like a road shoulder, it is there if more space is needed. It should be used for protruding elements, like corners or ornaments. - **Yellow** is like a road shoulder, it is there if more space is needed. It should be used for protruding elements, like corners or ornaments.
- **Red** is off limits. It should not be touched by the icons. Red is also how a circular icon would look. - **Red** is off limits. It should not be touched by the icons. Red is also how a circular icon would look.
## Edit Readme ## Reference Image and Brand Guidelines URl
You will need to update the README. To do this, run:
`python3 update_readme.py`
This will update the average file size at the top of the file as well as regenerate the table of icons.
## Reference Image
* Find an *official* logo. * Find an *official* logo.
* Add it to `/images/reference/` * Add it to `/images/reference/`
@@ -64,6 +56,15 @@ This will update the average file size at the top of the file as well as regener
* Add the brand guidelines URl in a new file within `/images/svg/` * Add the brand guidelines URl in a new file within `/images/svg/`
* For example, create a file called `/images/reference/nameofservice.url` with the contents `https://example.com/brand-guidelines` * For example, create a file called `/images/reference/nameofservice.url` with the contents `https://example.com/brand-guidelines`
## Edit Readme
You will need to update the README. To do this, run:
`python3 update_readme.py`
This will update the average file size at the top of the file as well as regenerate the table of icons.
It will also update the REFERENCE.md and CHECK.html files.
## (Optional) Create Android Version ## (Optional) Create Android Version
To convert in Android Studio, go to Tools ➡ Resource Manager ➡ Drawable ➡ + ➡ Import Drawables ➡ then select the SVGs. To convert in Android Studio, go to Tools ➡ Resource Manager ➡ Drawable ➡ + ➡ Import Drawables ➡ then select the SVGs.