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.
  16
  17   make
  18
  19 should build a usable binary.
  20
  21   make prefix=/some/dir mandir=/another/dir install
  22
  23 installs the pipeglade binary in /some/dir/bin/ and its manual page in
  24 /another/dir/man1/.  Default prefix is /usr/local/.  Default mandir is
  25 $(prefix)/man.
  26
  27 To get rid of the installation, call
  28
  29   make uninstall
  30
  31 or
  32
  33   make prefix=/some/dir mandir=/another/dir uninstall
  34
  35 respectively.
  36
  37
  38 TESTS AND FIRST STEPS
  39 =====================
  40
  41   ./pipegladetest.sh
  42
  43 runs pipeglade's tests (which require some human assistance).  The
  44 GtkBuilder file for the test GUI, pipeglade.ui, is also used in the
  45 demonstration script
  46
  47   ./echo.sh,
  48
  49 which redirects the messages initiated by user activity on the GUI
  50 back into a text area of the same GUI.  Another example,
  51
  52   ./clock.sh,
  53
  54 uses the GtkBuilder file clock.ui to display an analog clock, and
  55
  56   ./calc.sh
  57
  58 harnesses dc(1) to provide an RPN desk calculator.
  59
  60 There are three other example GtkBuilder files.  To see how they look
  61 like, call
  62
  63   ./pipeglade -u simple_dialog.ui
  64
  65 or
  66
  67   ./pipeglade -u simple_open.ui.
  68
  69 The third one, bad_window.ui, is for testing, and is intentionally
  70 broken.
  71
  72
  73 SUCCESSFUL BUILDS
  74 =================
  75
  76 Debian wheezy, GTK+ 3.4.2
  77 Debian Jessie, GTK+ 3.14.5
  78 FreeBSD 10.1, GTK+ 3.14.5
  79 FreeBSD 10.2, GTK+ 3.16.6
  80 Arch Linux, GTK+ 3.18.5