Skip to content

Commit 8db71fc

Browse files
authored
Reference fileicon in readme
1 parent b46615e commit 8db71fc

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

README.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ What do we have here...
1919

2020
## 👇 Downloading & using the icon(s)
2121

22+
### 🐌 The manual way
23+
2224
The easiest way will be for you to download the icon you want from the the [`icons`](./icons) directory. Simply find which macOS version you would like the icon for, and if applicable the light or dark mode variant, and download the `icns` file within that directory using GitHub's Download button once within a file's context:
2325

2426
<p align="middle">
@@ -31,11 +33,39 @@ To apply the icon, right click on the directory that you wish to update the icon
3133
<img src="art/get_info.png" width="30%" alt="macOS 'Get Info' dialogue window" />
3234
</p>
3335

34-
Ta-da! 🎉
36+
Ta-da! 🎉 You're all set, the icon should now be looking glorious.
37+
38+
### 🚀 The fun way
39+
40+
There's a brilliant tool called [`fileicon`](https://github.com/mklement0/fileicon) in which can programmatically set the icons of files and folders in macOS.
41+
42+
To install it via [`brew`](https://brew.sh/):
43+
44+
```sh
45+
brew install fileicon
46+
```
47+
48+
Then, if we assume that the directory we want to set the icon for is `~/git` and the downloaded icon resides in `~/Downloads/icon.icns`:
49+
50+
```sh
51+
# Assign the custom downloaded GitHub icon to ~/git
52+
fileicon set ~/git ~/Downloads/icon.icns
53+
```
54+
55+
Ta-da! 🎉 You're all set, the icon should now be looking glorious.
56+
57+
To restore the icon to its original state:
58+
59+
```sh
60+
# Remove the custom downloaded GitHub icon from ~/git
61+
fileicon rm ~/git
62+
```
63+
64+
More examples can be found under the [Examples heading in the `fileicon` README](https://github.com/mklement0/fileicon#examples).
3565

3666
## 🧰 Installing dependencies
3767

38-
I used to manually find and extract the folder icon upon every release, but someone recently introduced me to... [Folderify](https://github.com/lgarron/folderify)! Which has made maintaining this repo a breeze.
68+
I used to manually find and extract the folder icon upon every release, but someone recently introduced me to... [`folderify`](https://github.com/lgarron/folderify)! Which has made maintaining this repo a breeze.
3969

4070
Make sure [`brew`](https://brew.sh/) is installed (don't want to automate installing this on your system) and then go ahead and run the `make` command to get things setup:
4171

@@ -94,5 +124,6 @@ Although this step is run prior to generating new icons anyway.
94124
## 🎂 Sources
95125

96126
- Amazing GitHub icon: [Dave Gandy on flaticon](https://www.flaticon.com/free-icon/github-logo_25231)
97-
- Superb icon generation: [Folderify](https://github.com/lgarron/folderify)
127+
- Superb icon generation: [`folderify`](https://github.com/lgarron/folderify)
128+
- Brilliant icon application automation: [`fileicon`](https://github.com/mklement0/fileicon)
98129
- Fabulous macOS package manager: [`brew`](https://brew.sh/)

0 commit comments

Comments
 (0)