-
Notifications
You must be signed in to change notification settings - Fork 355
Introduce Icon Policy Documentation #310
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Icon policy | ||
| This document provides guidelines for contributing icons to Bitcoin Core. | ||
|
|
||
| ## Preparing Icons | ||
| Both an icon source file, in Scalable Vector Graphics (SVG) format, | ||
| and an optimized production file, in Portable Network Graphics (PNG) format, | ||
| are required for each icon. | ||
|
|
||
| #### SVG Source File | ||
| SVGs are used as source files because they can scale while retaining image quality. | ||
| They are not used in production due to limited application support. | ||
| If different-sized production (PNG) icons are required, | ||
| they can be generated from the associated SVG source file in any vector-based tool. | ||
|
|
||
| #### PNG Production File | ||
| PNGs are used in production due to wide application support, transparency support, | ||
| and better image quality compared to competing file types such as JPEG. | ||
|
|
||
| ### Optimizing Production Files (PNG): | ||
| Production (PNG) files must be processed by the [optimize-png.py](https://github.com/bitcoin-core/bitcoin-maintainer-tools/blob/master/optimise-pngs.py) script before their inclusion in Bitcoin Core. | ||
| PNG optimization removes various unnecessary color profiles, ancillary (alla), | ||
| and text chunks, resulting in a lossless reduction of the file's size. | ||
|
|
||
| ## Contributing | ||
| Bitcoin Core primarily uses icons from the [Bitcoin Icon set](https://github.com/BitcoinDesign/Bitcoin-Icons), | ||
| an open source icon set made for Bitcoin applications. | ||
| If a proposed feature requires an icon to be designed, | ||
| an issue should be opened in the [Bitcoin Icons repo](https://github.com/BitcoinDesign/Bitcoin-Icons/issues) | ||
| with the request. | ||
|
|
||
| Icons are not to be added to Bitcoin Core prior to a production use case. | ||
| If an icon is not being used, it should be removed. | ||
|
|
||
| SVGs are to be included under the `src/qt/res/src` directory. | ||
| Optimized PNGs are to be included under the `src/qt/res/icons` directory. | ||
|
|
||
| ## Attribution | ||
| Icon additions must include appropriate attribution to the author, license information, and any comments relevant to the icon documented under the | ||
| [contrib/debian/copyright](https://github.com/bitcoin-core/gui/blob/master/contrib/debian/copyright) file. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe (re?)state licensing expectations here?