docs(fullcolor): update fullcolor icons readme with up-to-date inform…

…ation
pop-os · Aug 8, 2022 · e27eb04 · e27eb04
1 parent eba8379
commit e27eb04
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/src/fullcolor/README.md b/src/fullcolor/README.md
@@ -8,11 +8,12 @@
     - Do this for each size of icon. This is crucial to rendering the icons without having redundant data.
     - If the final rendered icons are blank, double-check that the correct object is named. 
 
-**[render-bitmaps.py](./render-bitmaps.py) - the render script**
- - This script will render PNG icons, provided there are source changes, in both @1x and @2x (HiDPi) resolutions from the source files.
+**[render-fullcolor.py](./render-bitmaps.py) - the render script**
+ - This script will render SVG icons, provided the source file has been modified. Icons are rendered as SVG so they correctly scale to larger scale factors automatically.
  - You can render a single icon by passing the icon name to this script: `./render-bitmaps.rb <icon-name>`
 
 **[Template.svg](./Template.svg) - a blank icon template**
- - a blank template file for the fullcolor Paper icons (every icon follows this template.)
- - the template has as _Baseplate_ layer which will contain the necessary metadata for rendering an icon. (hidden by default)
- - You **must** change the `context` and `icon-name` labels on the _Baseplate_ for an icon to render properly (also hide the layer)
+ - A blank template file for the fullcolor Pop icons (every icon follows this template.)
+ - The template has as _Baseplate_ layer which will contain the necessary metadata for rendering an icon. (hidden by default)
+ - There is also a _Margins_ layer which gives some example margins/sizes for icons following general aspect ratios. Try to design icons following these aspect ratios as a start, and adapt where required. The margins are setup to give each icon a consistent general apparent size in the grid of all icons.
+ - You **must** change the `context` and `icon-name` labels on the _Baseplate_ for an icon to render properly (also hide the layer). Also, be sure to group each icon into a single object. Set the name for this object using the format {icon-name}-{size} (e.g. edit-delete-64)