How to recolor icons for doc.qt.io
==================================

You can view Qt Documentation online at https://doc.qt.io in dark and light
modes. To make the icons you use in the docs visible in both modes, save icon
files as gray-scale images with a transparent background.

If you receive a large number of icons that are not visible in either light
or dark mode or have a solid background, run the ``recolordocsicons.py``
Python script.

## Running the script

By default, the script recolors icons in `qtcreator/doc/qtcreator/images/icons`.

Use the `-docspath` option to specify the path to another icon source folder.

For example, if you saved the new icons in `C:\iconconversions`, switch to
the `qtcreator\src\tools\icons` folder and enter:

`recolordocsicons.py -docspath C:\iconconversions`

## Preparation

To run the script, you will need to install the following tools and add them
to the PATH:

- Python 3.x (the script has been tested to work with 3.10)
- ImageMagick
- optipng