|
2 | 2 |
|
3 | 3 | Icon Repository for [Nativefier](https://github.com/nativefier/nativefier/).
|
4 | 4 |
|
5 |
| -Nativefier will look in this repository for high resolution icons before trying to automatically infer an icon from the target Url. |
6 |
| - |
7 |
| -The [index](https://nativefier.github.io/nativefier-icons/) is automatically generated with [GitCloud](https://github.com/jiahaog/gitcloud) using Jekyll. |
8 |
| - |
9 |
| -## Contributing |
10 |
| - |
11 |
| -Feel free to submit a pull request for any `.ico`, `.icns` or `.png` icon! |
12 |
| - |
13 |
| -- `.ico` - For Windows |
14 |
| -- `.icns` - For macOS (Apple Icon Image format) |
15 |
| -- `.png` - For Linux |
16 |
| - |
17 |
| -If the icons for the correct platforms are found here, the [optional dependencies](https://github.com/nativefier/nativefier/#optional-dependencies) for Nativefier might not be required to infer an icon for that particular target web page. |
18 |
| - |
19 |
| -### Naming Convention |
20 |
| - |
21 |
| -Name the icon file to `${PRODUCT}.${EXT}`, just use the key identifier for the page. |
22 |
| - |
23 |
| -However, if the product name is generic enough, name it as `${COMPANY}-${PRODUCT}.${EXT}`, with `-` as the delimiter. The matching algorithm works by taking a score of the number of words matched in the file name with the target url. |
24 |
| - |
25 |
| -Take the example of naming Google Photos for the target url `https://photos.google.com/`. Using `photos.png` is too generic, and we want it to be specific to google. Thus, we will name the icon file `google-photos.png` for a `.png` file. |
26 |
| - |
27 |
| -### Step 1 |
28 |
| - |
29 |
| -First prepare the image files, for the respective platform as stated above |
30 |
| - |
31 |
| -A helpful tool for converting the icons is [iconverticons.com](https://iconverticons.com/online/). |
32 |
| - |
33 |
| -Copy the images to `./files`. |
34 |
| - |
35 |
| -``` |
36 |
| -$ ls -a ./files |
37 |
| -
|
38 |
| -google-photos.png |
39 |
| -google-photos.ico |
40 |
| -google-photos.icns |
41 |
| -``` |
42 |
| - |
43 |
| -### Step 2 |
44 |
| - |
45 |
| -Add an entry for the file to `./_data/gitCloud.yml`, in alphabetical order |
46 |
| - |
47 |
| -```yml |
48 |
| -- name: google-photos |
49 |
| - href: files/google-photos.png |
50 |
| -- name: google-photos |
51 |
| - href: files/google-photos.ico |
52 |
| -- name: google-photos |
53 |
| - href: files/google-photos.icns |
54 |
| -``` |
55 |
| -
|
56 |
| -### Step 3 |
57 |
| -
|
58 |
| -You're done! Submit a pull request with the changes and I'll merge them in as soon as possible. |
59 |
| -
|
60 |
| -## Helper Scripts |
61 |
| -
|
62 |
| -The main [`./addIcon`](addIcon) script is also provided which takes an input `.png` or `.svg` and does steps 1 and 2 automatically for you. |
63 |
| - |
64 |
| -This script only runs on OSX with XCode installed as [iconutil](https://developer.apple.com/library/mac/documentation/GraphicsAnimation/Conceptual/HighResolutionOSX/Optimizing/Optimizing.html) is required for conversion to a `.icns` file. |
65 |
| - |
66 |
| -Other helpful scripts are: |
67 |
| - |
68 |
| -- [`./bin/convertToIcns`](bin/convertToIcns) |
69 |
| -- [`./bin/convertToIco`](bin/convertToIco) (Supported on Linux) |
70 |
| -- [`./bin/convertToPng`](bin/convertToPng) (Supported on Linux) |
71 |
| - |
72 |
| -You need the following dependencies: |
73 |
| - |
74 |
| -- [ImageMagick](http://www.imagemagick.org/script/index.php) with `convert` and `identify` in your `$PATH` (required for `.png` input) |
75 |
| -- [CairoSVG](https://cairosvg.org) (required for `.svg` input) |
76 |
| -- [iconutil](https://developer.apple.com/library/mac/documentation/GraphicsAnimation/Conceptual/HighResolutionOSX/Optimizing/Optimizing.html): Xcode needs to be installed (required to generate `.icns`) |
77 |
| - |
78 |
| -## Work In Progress |
79 |
| - |
80 |
| -- [ ] CI tests for pull requests |
81 |
| -- [ ] Just use a `.png` or `.svg` and let CI convert the icons to the other formats |
82 |
| - |
83 |
| -## Credits |
84 |
| - |
85 |
| -Some logos are sourced and converted from the really awesome svg logo repository [gilbarbara/logos](https://github.com/gilbarbara/logos). |
86 |
| - |
87 |
| -All logos appearing on the site are the property of their respective owners. |
| 5 | +This repo is archived and exists only for compatibility with older verisons of Nativefier. Please update Nativefier past `42.2.0` and go to [the updated repository](https://github.com/nativefier/nativefier-icons) instead. |
0 commit comments