README

   1 Graphical User Interfaces, The UNIX Way
   2 =======================================
   3
   4 Pipeglade is a helper program that displays graphical user interfaces
   5 for other programs. It renders the GUI definition found in a
   6 GtkBuilder file (created using the Glade Interface Designer), and
   7 communicates with the main program solely via pipes or fifos.
   8
   9 Visit http://pipeglade.boundp.org
  10
  11
  12 INSTALLATION
  13 ============
  14
  15 GTK+ v3.2 or newer and libxml2 are required.  Prerequisite Debian
  16 packages are pkg-config, libgtk-3-dev, and libxml2-dev.
  17
  18   make
  19
  20 should build a usable binary.
  21
  22   make prefix=/some/dir mandir=/another/dir install
  23
  24 installs the pipeglade binary in /some/dir/bin/ and its manual page in
  25 /another/dir/man1/.  Default prefix is /usr/local/.  Default mandir is
  26 $(prefix)/man.
  27
  28 To get rid of the installation, call
  29
  30   make uninstall
  31
  32 or
  33
  34   make prefix=/some/dir mandir=/another/dir uninstall
  35
  36 respectively.
  37
  38
  39 TESTS AND FIRST STEPS
  40 =====================
  41
  42   ./pipegladetest.sh
  43
  44 runs all of pipeglade's tests, some of which require human
  45 assistance.  Subsets of these tests can be run by
  46
  47   ./pipegladetest.sh automatic
  48
  49 or
  50
  51   ./pipegladetest.sh interactive
  52
  53 The GtkBuilder file for the test GUI, pipeglade.ui, is also used in
  54 the demonstration script
  55
  56   ./echo.sh,
  57
  58 which redirects the messages initiated by user activity on the GUI
  59 back into a text area of the same GUI.  Another example,
  60
  61   ./clock.sh,
  62
  63 uses the GtkBuilder file clock.ui to display an analog clock, and
  64
  65   ./calc.sh
  66
  67 harnesses dc(1) to provide an RPN desk calculator.
  68
  69 There are three other example GtkBuilder files.  To see how they look
  70 like, call
  71
  72   ./pipeglade -u simple_dialog.ui
  73
  74 or
  75
  76   ./pipeglade -u simple_open.ui.
  77
  78 The third one, bad_window.ui, is for testing, and is intentionally
  79 broken.
  80
  81
  82 SUCCESSFUL BUILDS
  83 =================
  84
  85 Debian wheezy, GTK+ 3.4.2
  86 Debian Jessie, GTK+ 3.14.5
  87 FreeBSD 10.1, GTK+ 3.14.5
  88 FreeBSD 10.2, GTK+ 3.16.6
  89 Arch Linux, GTK+ 3.18.5