Skip to content

Commit 56a558c

Browse files
authored
Add README for Message Icons usage instructions
This README provides instructions for adding custom icons to the message display app.
1 parent 54cac5a commit 56a558c

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

apps/messageicons/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Message Icons
2+
Provides icons for phone apps that are utilized by `message gui` and any other message display app.
3+
4+
## Adding your own icons
5+
- Clone the repo on your local machine, if you haven't done so already.
6+
- Locate the image you want to use as an icon. Make sure it is 24x24px, and has a black foreground and transparent background (you can color the foreground one color only later on)
7+
- Upload it to the `icons` folder in the `messageicons` folder.
8+
- Add your app name and the corresponding image you added to the `icon_names.json` file
9+
- Run the `generate.js` script. Be sure you have the `png-js` dependency needed. (you can install it by running `npm install png-js` in the terminal)
10+
- Once finished generating, navigate to the `lib.js` file, and add the color for your foreground and the corresponding app.

0 commit comments

Comments
 (0)