Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

82 lines (52 loc) · 3.42 KB

Lawnicons contributing guide

Welcome to the Lawnicons contributing guide! This file will tell you what you need to know to contribute to Lawnicons.

Icon guidelines

See the below image for a summary of the icon guidelines. If you don't follow them, a team member will likely request changing the icons.

Each icon must fit the 160x160px or 144x144px (depending on the shape) content area size. It must not be smaller nor bigger than the specified sizes.

The stroke should be kept at 12px for most lines. If 12px is too thick, a stroke of 8px can be used.

In addition to the above, the icons must have an outlined (not filled) style. If the original icon has a filled style, you should change the icon to adhere to the guidelines as seen below.

Adding an icon to Lawnicons

Here’s how to add an icon to Lawnicons:

Via icontool.py

Please check the icon tool guide for more information.

Via manual process

  1. Prepare your icon in the SVG format, adhering to the above guidelines. Use snake case for the filename (e.g. files_by_google.svg).

  2. Add the ready SVG to the svgs directory.

  3. Add a new line to app/assets/appfilter.xml (in alphabetical order, by the name-tag), and map the new icon to a package name and app's activity. For example:

      <item component="ComponentInfo{com.google.android.apps.nbu.files/com.google.android.apps.nbu.files.home.HomeActivity}" drawable="files_by_google" name="Files by Google"/> 

    A general template is as follows:

    <item component="ComponentInfo{[PACKAGE_NAME]/[APP_ACIVITY_NAME]}" drawable="[DRAWABLE NAME]" name="[APP NAME]"/> 
  4. Done! You’re ready to open a pull request. Please set develop as the base branch.

How to find the package and activity name of your app

Using adb via computer/phone with OTG

  1. Connect your Android device or emulator to the PC/Mac/Phone via otg and open the app whose details you want to inspect, i.e. Files by Google.
  2. Open a new Command Prompt or Terminal window and input adb devices
  3. Finally, type the below-given command to get the information about the currently open application.

For Mac/Linux:

adb shell dumpsys window | grep 'mCurrentFocus'  

For Windows:

adb shell dumpsys window | find "mCurrentFocus"

Here, the part before the / character i.e org.telegram.messenger is the package name [PACKAGE_NAME] and the part after that i.e org.telegram.messenger.DefaultIcon is the Activity name [APP_ACIVITY_NAME].

Using 3rd Party Apps.

Icon Request App

  1. Download Icon Request App.
  2. Launch the app and click ok, let's start.
  3. Get the Activity details for each app.

OR

Icon Pusher App

  1. Download Icon Pusher App.
  2. Launch the app.
  3. Select the icon(s) you want to upload or select all by pressing the square in the top right. Then press send.
  4. View the Activity details for each app on the Icon Pusher website. Please make sure the drawable="[DRAWABLE NAME]" matches the icon SVG file name.