icons/README.md

   1 README before changing things:
   2 ==============================
   3
   4 In this folder a lot of content is generated:
   5
   6 | Folder- or Filename     | Generated by               | Additional Info      |
   7 | ----------------------- | -------------------------- | -------------------- |
   8 | breeze/                 | import_theme.pl            |                      |
   9 | breezedark/             | import_theme.pl            |                      |
  10 | extra-icons/breeze/     | quassel-icons              |                      |
  11 | extra-icons/breezedark/ | quassel-icons              |                      |
  12 | extra-icons/oxygen/     | -                          | see note (a)         |
  13 | hicolor/                | partially by quassel-icons | see note (b)         |
  14 | import/                 | -                          | see import_theme.pl  |
  15 | oxygen/                 | import_theme.pl            | see note (a)         |
  16 | breeze.qrc              | import_theme.pl            |                      |
  17 | breezedark.qrc          | import_theme.pl            |                      |
  18 | breezedark-extra.qrc    | -                          | see note (c)         |
  19 | breeze-extra.qrc        | -                          | see note (c)         |
  20 | CMakeLists.txt          | -                          |                      |
  21 | hicolor.qrc             | -                          |                      |
  22 | oxygen.qrc              | import_theme.pl            | see note (a)         |
  23 | oxygen-extra.qrc        | -                          | see note (a) and (c) |
  24 | README.Breeze           | -                          | see import_theme.pl  |
  25 | README.BreezeDark       | -                          | see import_theme.pl  |
  26 | README.md               | -                          |                      |
  27 | README.Oxygen           | -                          | see import_theme.pl  |
  28
  29 # import_theme.pl
  30
  31 To update the packaged icon themes you use the import_theme.pl
  32 Check the top of the script for more detailed usage guide. But basically you need up to date
  33 copies of the complete icon themes (e.g. in your home folder) and then run this:
  34 ```
  35 ./import/import_theme.pl ~/oxygen-icons oxygen
  36 ./import/import_theme.pl ~/breeze-icons/icons breeze ICONS
  37 ./import/import_theme.pl ~/breeze-icons/icons-dark breezedark ICONS
  38 ```
  39 Note: there are additional blacklist/whitelist files in the import folder used by this script
  40 Please update the commit info in the theme's Readme on update.
  41
  42 # [quassel-icons](https://github.com/justjanne/quassel-icons)
  43
  44 The quassel-icons repository ([https://github.com/justjanne/quassel-icons](https://github.com/justjanne/quassel-icons))
  45 by justjanne is used to generate the extra-icons folders (except the oxygen extra icons), the quassel icons in hicolor/
  46 as well as the ico and icns in the pics folder (outside of this icons folder). It's also used for other quassel projects
  47 like Quasseldroid.
  48 To update, follow the guide there and copy the output into this repository.
  49
  50 # Notes
  51
  52 |     | Notes                                                                           |
  53 | --- | ------------------------------------------------------------------------------- |
  54 | (a) | all oxygen related files are planned to be dropped soon™                        |
  55 | (b) | in hicolor/ there are additional icons that are not generated by quassel-icons. |
  56 | (c) | the qrc files are not yet generated by this, but it is planned to change that.  |