Skip to content

Commit

Permalink
Merge branch 'nightly-releases' of [email protected]:Hamster45105/lawnic…
Browse files Browse the repository at this point in the history
…ons.git
  • Loading branch information
Hamster45105 committed Sep 7, 2024
2 parents 8d5a4e0 + bad256b commit dd85d7b
Show file tree
Hide file tree
Showing 86 changed files with 882 additions and 686 deletions.
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Link apps to existing icons
url: https://github.com/LawnchairLauncher/lawnicons/blob/develop/CONTRIBUTING.md#adding-an-icon-to-lawnicons
about: Learn more about linking an app to an existing icon and making a PR to contribute to Lawnicons.
- name: Icon Request
url: https://forms.gle/xt7sJhgWEasuo9TR9
about: Please request your icons in this form.
10 changes: 5 additions & 5 deletions .github/icon_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ While waiting for a review from our team, you can do a self-review to ensure tha
1. Canvas: `192×192px`.
2. Non-square icons: the long side of the icons should be `160px`.
3. Square icons: `154×154px`.
- [ ] Done
- [ ] Approved by the Lawnicons reviewer
### Color, stroke width and rounding
1. Color: black `#000`.
1. Color: non-transparent black `#000`.
2. No fill. Base stroke width: `12px`. `14px`, `10px`, `8px` — depending on the shape of the icons. `6px` — for fine details.
3. Rounded ends and joins. 90° corners are rounded by `6-32px`.
- [ ] Done
- [ ] Approved by the Lawnicons reviewer
### Naming
1. Names should match the official app name and contain no additional text.
2. If the first `3` characters of the app name contain letters not from the English alphabet, then add a localized (or transliterated) name via `~~`. Example: `京东 ~~ JD`.
3. The names of the drawables should repeat the names of the apps if nothing prevents it.
- [ ] Done
- [ ] Approved by the Lawnicons reviewer
### Quality
1. Ensure that icons are easily recognizable.
2. Align icons to [the visual center](https://crazybitsstudios.com/another-way-of-aligning-elements-when-creating-icons) as much as possible within the guidelines. The visual center is where your icon looks and feels centered.
3. Avoid noticable black spots by reducing the stroke width or simplifying the icons.
4. Avoid close distances between strokes. The icons on the phone screen will be smaller, so the small distances between the strokes will stick together.
5. Avoid drastic changes in stroke widths. When the strokes next to each other differ in width by 4px or more, the icon will look sloppy.
- [ ] Done
- [ ] Approved by the Lawnicons reviewer
30 changes: 17 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,31 +123,35 @@ Correct
```

## Adding an icon to Lawnicons
Here's how to add an icon to Lawnicons:

### Prerequisites
* Your icon in the SVG format, adhering to the [above guidelines](#contributing-icons). The filename must use snake case (e.g. `files_by_google.svg`).
* The package and activity name of the app.
* A fork of the Lawnicons repository;
* Your icon in the SVG format, adhering to the [above guidelines](#contributing-icons). The filename must use snake case (e.g. `spck_editor.svg`).
* The package and activity name of the app;

### Via `icontool.py`
Please check the [icon tool guide](/docs/icontool_guide.md) for more information.
Please check [the icon tool guide](/docs/icontool_guide.md) for more information.

### Via manual process
1. Add the ready SVG to the `svgs` directory.
1. Add the ready SVG to the `svgs` directory. If you want to add a link to an existing SVG, you will need its name.

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

**Example**
- the app name: `Spck Editor`;
- the svg (drawable) name: `spck_editor`;
- the package and activity of the app: `io.spck/io.spck.EditorActivity`.

**The new line**
```xml
<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"/>
<item component="ComponentInfo{io.spck/io.spck.EditorActivity}" drawable="spck_editor" name="Spck Editor"/>
```

A general template is as follows:

**General template**
```xml
<item component="ComponentInfo{[PACKAGE_NAME]/[APP_ACIVITY_NAME]}" drawable="[DRAWABLE NAME]" name="[APP NAME]"/>
```

1. Done! You're ready to open a pull request. Please set `develop` as the base branch.
4. Done! You're ready to open a pull request. Please set `develop` as the base branch.

## Finding the package and activity name of an app

Expand All @@ -158,8 +162,8 @@ Please check the [icon tool guide](/docs/icontool_guide.md) for more information

### Using `adb`
1. Connect your Android device or emulator to your laptop/desktop PC that has `adb` installed (see [this tutorial](https://www.xda-developers.com/install-adb-windows-macos-linux/) for more information) and open the app whose details you want to inspect, e.g. Telegram.
1. Open a new Command Prompt or Terminal window and input `adb devices`.
1. Finally, type the below-given command to get the information about the currently open application.
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 or Linux**:

Expand Down
Loading

0 comments on commit dd85d7b

Please sign in to comment.