README

   1 About:
   2 ------
   3
   4 Yelp is the default help browser for the GNOME desktop.  Yelp provides
   5 a simple graphical interface for viewing DocBook, HTML, man, and info
   6 formatted documentation.  The name Yelp was suggested by Daniel Lundin.
   7 Yelp is pronounced the same as the swedish word for 'help'.
   8
   9
  10 Requirments:
  11 ------------
  12
  13 * GNOME 2.0 ( >= 2.0.2 )
  14 * A working ScrollKeeper installation ( > 0.3.14 )
  15 * GNOME Documentation Utilities (gnome-doc-utils > 0.5.2)
  16 * Version 4.1.2 of the DocBook XML DTD
  17
  18 Note that Yelp requires gnome-doc-utils for the DocBook XSLT stylesheets.
  19 These stylesheets are optimized for speed and allow better integration
  20 with Yelp.
  21
  22
  23 Reporting bugs:
  24 ---------------
  25
  26 Bugs should be reported to the GNOME bug tracking system
  27 (http://bugzilla.gnome.org, product Yelp.) You will need to create an
  28 account for yourself.
  29
  30
  31 Sending patches:
  32 ----------------
  33
  34 Please submit your patches to bugzilla.gnome.org. If the patch
  35 fixes an existing bug, add the patch as an attachment to that bug
  36 report.
  37
  38 Otherwise, enter a new bug report that describes the patch, and attach
  39 the patch to that bug report.
  40
  41 Bug reports containing patches should include the PATCH keyword in their
  42 keyword fields. If the patch adds to or changes the GTK programming
  43 interface, the API keyword should also be included.
  44
  45 Patches should be in unified diff form. (The -u option to GNU diff.)
  46
  47
  48 Help on setting your system up:
  49 -------------------------------
  50
  51 A brief note on how to get the docbook stuff to work.
  52
  53 1) Install Scrollkeeper 0.3.14:
  54 http://prdownloads.sourceforge.net/scrollkeeper/scrollkeeper-0.3.14.tar.gz
  55
  56 Edit /etc/scrollkeeper.conf to include your $(gnome2_prefix)/share/omf
  57 directory. For best use in GNOME 2.0, remove all other directories.
  58
  59 Run scrollkeeper-update.
  60