README
General Information
===================

This is version 3.24.9 of GtkSourceView.

GtkSourceView is a text widget that extends the standard GTK+ text widget
GtkTextView.

It improves GtkTextView by implementing syntax highlighting and other
features typical of a source code editor.

The official web site is:

    https://wiki.gnome.org/Projects/GtkSourceView

The GtkSourceView library is free software and is released under the terms of
the GNU Lesser General Public License.


Installation
============

GtkSourceView requires GLib >= 2.48, GTK+ >= 3.20 and libxml2 >= 2.6.

Simple install procedure:

  $ ./configure
  $ make
  [ Become root if necessary ]
  $ make install

See the file 'INSTALL' for more detailed information.

From the Git repository, the 'configure' script and the 'INSTALL' file are not
yet generated, so you need to run 'autogen.sh' instead, which takes the same
arguments as 'configure'.

To build the latest version of GtkSourceView from Git, Jhbuild can be used:

    https://wiki.gnome.org/Projects/Jhbuild


How to report bugs
==================

Bugs should be reported to the GNOME bug tracking system:

    https://bugzilla.gnome.org/page.cgi?id=browse.html&product=gtksourceview

You will need to create an account for yourself.

Please search to see if the bug is not already reported. If not, file a new bug
and include:
  
* Information about your system. For instance:

   - What version of GtkSourceView
   - What operating system and version
   - What version of GTK+ and GLib

  And anything else you think is relevant.

* How to reproduce the bug. 

* If the bug was a crash, the exact text that was printed out when the
  crash occurred, with a backtrace from gdb with debug symbols. See:
  https://wiki.gnome.org/Community/GettingInTouch/Bugzilla/GettingTraces


Patches
=======

Patches should also be submitted to bugzilla.gnome.org. If the patch
fixes an existing bug, add the patch as an attachment to that bug
report.

Otherwise, enter a new bug report that describes the problem the patch
fixes, and attach it to that bug report.

Patches should be created with the git format-patch command.
Please follow the coding style described in the HACKING file.

If you are interested in helping us to develop GtkSourceView, please see the 
file 'MAINTAINERS' for contact information and/or send a message to
the GtkSourceView mailing list. See also the file 'HACKING' for
information about our git guidelines.


The GtkSourceView team.