Skip to content
This repository has been archived by the owner on Dec 20, 2018. It is now read-only.

Add a section to the README for icon generation #74

Merged
merged 1 commit into from
Nov 16, 2017

Conversation

jrjohnson
Copy link
Contributor

Uses the ember-cli-image-transformer addon to convert a single image
into multiple needed icon sizes.

@san650 as we discussed in Slack here are some basic docs for using ember-cli-image-transformer to build icons for web apps. I wasn't too sure what should be included here so please let me know if I missed the mark.

@san650
Copy link
Owner

san650 commented Nov 15, 2017

@jrjohnson as you can see, one of the original ideas of the addon was to tackle the image generation as one of the features, but I'm glad there's a different addon that do that work!

I like the documentation you added, I left some comments. Let me know your thoughts!

README.md Outdated
@@ -53,6 +49,7 @@ See the [documentation](#documentation) section below for more information.
* [`apple.webAppCapable`](#applewebappcapable)
* [`ms`](#ms)
* [`ms.tileColor`](#mstilecolor)
* [Generating Icons](#ieneratingicons)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the link is not correct, it should be #generatingicons

README.md Outdated
@@ -732,6 +729,48 @@ manifest.ms = {
};
```

## Generating Icons

Managing all the various icon sizes and types can be overwhelming. One solution is to start with a base image which can be
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a paragraph above this one to make it clear that you have to install this other addon first.

ember-web-app doesn't generate icons or images. If you want to automate the generation of icons starting from a master image, you can install ember-cli-image-transformer.

What do you think? So people don't get the wrong idea that this addon installs ember-cli-image-transformer.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, that will be a lot clearer.

README.md Outdated
"type": "image/png"
}
]
```
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just an idea here, maybe we can use the same size array that you use in the other config. I like to give users ideas on how to make the config a bit more DRY 😄

// config/manifest.js
export default function() {
  return {
    icons: [192, 512].map((size) => ({
      src: `/images/icons/android-chrome-${size}.png`,
      sizes: `${size}`,
      type: "image/png"
    }))
  };
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this especially. I'm 100% going to steal it to improve our manifest.js!

@jrjohnson
Copy link
Contributor Author

Thanks for the quick feedback @san650. Those all looks like great additions. I will try and get them done in the next 24 hours.

Uses the ember-cli-image-transformer addon to convert a single image
into multiple needed icon sizes.
@jrjohnson
Copy link
Contributor Author

I ended up having some time tonight, so these changes are made now.

@san650
Copy link
Owner

san650 commented Nov 16, 2017

Thanks for contributing!

@san650 san650 merged commit 9786926 into san650:master Nov 16, 2017
@jrjohnson jrjohnson deleted the add-icon-docs branch November 16, 2017 15:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants