Add a README to the icons folder

diff --git a/icons/README.md b/icons/README.md
new file mode 100644 (file)
index 0000000..e82f552
--- /dev/null
+++ b/icons/README.md
@@ -0,0 +1,56 @@
+README before changing things:
+==============================
+
+In this folder a lot of content is generated:
+
+| Folder- or Filename     | Generated by               | Additional Info      |
+| ----------------------- | -------------------------- | -------------------- |
+| breeze/                 | import_theme.pl            |                      |
+| breezedark/             | import_theme.pl            |                      |
+| extra-icons/breeze/     | quassel-icons              |                      |
+| extra-icons/breezedark/ | quassel-icons              |                      |
+| extra-icons/oxygen/     | -                          | see note (a)         |
+| hicolor/                | partially by quassel-icons | see note (b)         |
+| import/                 | -                          | see import_theme.pl  |
+| oxygen/                 | import_theme.pl            | see note (a)         |
+| breeze.qrc              | import_theme.pl            |                      |
+| breezedark.qrc          | import_theme.pl            |                      |
+| breezedark-extra.qrc    | -                          | see note (c)         |
+| breeze-extra.qrc        | -                          | see note (c)         |
+| CMakeLists.txt          | -                          |                      |
+| hicolor.qrc             | -                          |                      |
+| oxygen.qrc              | import_theme.pl            | see note (a)         |
+| oxygen-extra.qrc        | -                          | see note (a) and (c) |
+| README.Breeze           | -                          | see import_theme.pl  |
+| README.BreezeDark       | -                          | see import_theme.pl  |
+| README.md               | -                          |                      |
+| README.Oxygen           | -                          | see import_theme.pl  |
+
+# import_theme.pl
+
+To update the packaged icon themes you use the import_theme.pl
+Check the top of the script for more detailed usage guide. But basically you need up to date
+copies of the complete icon themes (e.g. in your home folder) and then run this:
+```
+./import/import_theme.pl ~/oxygen-icons oxygen
+./import/import_theme.pl ~/breeze-icons/icons breeze ICONS
+./import/import_theme.pl ~/breeze-icons/icons-dark breezedark ICONS
+```
+Note: there are additional blacklist/whitelist files in the import folder used by this script
+Please update the commit info in the theme's Readme on update.
+
+# [quassel-icons](https://github.com/justjanne/quassel-icons)
+
+The quassel-icons repository ([https://github.com/justjanne/quassel-icons](https://github.com/justjanne/quassel-icons))
+by justjanne is used to generate the extra-icons folders (except the oxygen extra icons), the quassel icons in hicolor/
+as well as the ico and icns in the pics folder (outside of this icons folder). It's also used for other quassel projects
+like Quasseldroid.
+To update, follow the guide there and copy the output into this repository.
+
+# Notes
+
+|     | Notes                                                                           |
+| --- | ------------------------------------------------------------------------------- |
+| (a) | all oxygen related files are planned to be dropped soon™                        |
+| (b) | in hicolor/ there are additional icons that are not generated by quassel-icons. |
+| (c) | the qrc files are not yet generated by this, but it is planned to change that.  |