ameixa/CONTRIBUTING.md

8.2 KiB

#FAQ

Is there any template for drawing icons?

  • Yes, you have one for each color of the palette. You just have to worry about the design of the logo and its proportions. Take a look at the wiki

Is there any guidelines to follow drawing the icons?

  • It is convenient to visit the Google Material Design website. The templates include most of the items, so you will not have to worry about them, but this site provides much interesting information you should follow when designing.

The update don't aply the new icons

  • Probably a CM13 bug (?). You can solve it applying the stock icon pack and then applying again Ameixa.

I had a themed icon, but a recent update of the app reverts it to the original one

  • Probably the upstream changes the activity name into androidmanifest.xml. You can compare the activityname using Turtl with the code of appfilter. If the activityname have changed in fact, then you can try to do a MR with a patch, or request for a fix trough Issue tracker

An app crashes when attempts to create a notification icon with the theme applied.

I see the icon of an app in its folders but it's not working in the theme

  • Probably there is an error into the appfilter.xml.
    1. Look if drawable="iconname" /> match the icon name of the png into the folders
    2. Look if the activity name is right (You can use Turtl).
    3. Feel free to open a MR with a patch or request a fix

How can I build the app by myself?

How to add an icon

Steps:

  1. Draw a white icon on its layer of the SVG template,
  2. Put your svg icon into the SVG wip folder,
  3. Add the activity of the app to appfilter.xml and add the icon's license to the LICENSE file.
  4. (Optional) Run the script proccess_wipsvg.sh. (It generates the proper pngs and move the svg from wip to depot folder.)

Breaf instructions: A template file contains three layers (to see them, select Layer - Layers from the menu; to toggle layer visibility, use the eye-like icons near the layer names). The bottom layer contains the background of the icon. It has proper color, shadow, shade and tint. Do not modify those.

The top layer (hints) shows the keyline shapes, the regions that define the size of your icon. In short, a mostly square icon must fit into a square one (black lines). A horizontal rectangle, in the horizontal rectangle (blue lines). A vertical rectangle icon, into the vertical rectangle (green lines) and the mostly round one should mostly fit in the larger square-without-the-corners that they form. Most part of your icon should fit into one or several of those rectangles. Note that small items can extend beyond this area. For more information on this, please refer to the section "Proportions" below and to the Google's guide.

The icon layer is the most interesting one. This is the layer you should draw your icon on. It already contains an indication, please delete it and draw the desired logo in white (#ffffffff) instead of it.

Add Activities to appfilter.xml

You can use Turtle to obtain the code. Note Turtl sets the iconname as a string (related to the activityname). You have to change the string inside: drawable="xxxxxxxxxx" /> and make sure it is identical to the .svg you put into the svgs/wip folder.

Proportions

style_logos_product_grid_shapes_vert_rectanglestyle_logos_product_grid_shapes_hori_rectanglestyle_logos_product_grid_shapes_squarestyle_logos_product_grid_shapes_circle

Resolutions

RESOLUTION PX DPI
MDPI 48x48 120
HDPI 72x72 240
XHDPI 96x96 320
XXHDPI 144x144 480
XXXHDPI 192x192 640

More info

Please read this carefully for a deeper understanding:

Add Material Color Palette to Inkscape

[Material Design Color Palette for Inkscape] (https://github.com/MaTriXy/Material-Design-Color-Palette-for-Inkscape)

Creating a Boot Animation

See this link