summaryrefslogtreecommitdiffstats
path: root/share/extensions/inkex/gui/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'share/extensions/inkex/gui/README.md')
-rw-r--r--share/extensions/inkex/gui/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/share/extensions/inkex/gui/README.md b/share/extensions/inkex/gui/README.md
new file mode 100644
index 0000000..fb176da
--- /dev/null
+++ b/share/extensions/inkex/gui/README.md
@@ -0,0 +1,15 @@
+# What is inkex.gui
+
+This module is a Gtk based GUI creator. It helps extensions launch their own user interfaces and can help make sure those interfaces will work on all platforms that inkscape ships with.
+
+# How do I use it
+
+You can create custom user interfaces by using the Gnome glade builder program. Once you have a layout of all th widgets you want, you then make a GtkApp and Window classes inside your python program, when the GtkApp is run, th windows will be shown to the user and all signals specified for the widgets will call functions on your window class.
+
+Please see the existing code for examples of how to do this.
+
+# This is a fork
+
+This code was originally part of the package 'gtkme' which contained some part we didn't want to ship. Such as ubuntu indicators and internet pixmaps. To avoid conflicts, our stripped down version of the gtkme module is renamed and placed inside of inkscape's inkex module.
+
+