The Gtk# website can be found at: http://www.mono-project.com/GtkSharp

Gtk# is a .NET language binding for the GTK+ toolkit and assorted GNOME
libraries. Gtk# is free software, licensed under the GNU LGPL.

Building & Installing Gtk#:
---------------------------

    Install the gtk-3 development headers first. On Debian, this can be done using:
    apt-get install libgtk-3-dev

    The build is the traditional:

        ./configure
        make
        make install

    You may want to consider using configure's prefix option to install
    Gtk# using the same prefix as Mono.  That way all of your .NET assemblies
    get placed in the same place, and you don't need to do any extra "configuring"
    to make it so mono (and mint) can find your assemblies.  In other words,
    doing something like:

        ./configure --prefix=`pkg-config --variable=prefix mono`
        make
        make install

    If you are compiling from GIT, you will need libtool and the auto* tools
    and will need to replace the configure above with autogen.sh.


The gui-thread-check profiler module.
-------------------------------------

    Since version 3 of gtk# a profiler called "gui-thread-check" is included as
    part of the install for debugging purposes. (It's located in the subfolder
    gtk/gui-thread-check .)

    This profiler module can be used to check if a GTK# application is trying to
    invoke gtk or gdk methods from a thread which is not the main GUI thread.

    To use it, run your application with the command:

        mono --profile=gui-thread-check yourapp.exe

    If the profiler is properly installed, you'll see an output like this:

        *** Running with gui-thread-check ***
        *** GUI THREAD INITIALIZED: 2861676352

    While the application is running, if the profiler detects a non-gui thread
    invoking gtk methods, it will print a warning message together with a
    stack trace. For example:

        *** GTK CALL NOT IN GUI THREAD: Widget.gtk_widget_get_parent
           Widget.get_Parent
           SourceEditorWidget.SetLastActiveEditor
           SourceEditorWidget.get_TextEditor
           SourceEditorWidget.get_Document
           SourceEditorWidget.HandleParseInformationUpdaterWorkerThreadDoWork
           BackgroundWorker.OnDoWork
           BackgroundWorker.ProcessWorker


Discussion & Support:
---------------------

    A mailing list for Gtk# discussion is available.

    You can subscribe to the mailing list by visiting:

        http://lists.ximian.com/mailman/listinfo/gtk-sharp-list

    And following the instructions (on that page) to subscribe.
    Messages are posted on this mailing list by sending them to:

        gtk-sharp-list@ximian.com

    (The mailing list requires you to subscribe in order to post
    messages.)

    An archive of this mailing list can be found at:

        http://lists.ximian.com/archives/public/gtk-sharp-list/

    Also, people can get help with and discuss Gtk# on IRC via the
    #gtk# or #mono channels on the irc.gnome.org IRC server.

    People looking for general help with C# should visit the
    #c# channel on irc.freenode.net IRC server.


Developers:
-----------

    For developers wishing to "get started" with Gtk#, they are encouraged
    to read the Mono Hand Book:

        http://www.mono-project.com/Monkeyguide


Hackers:
--------

    For those who wish to help with the development of Gtk#, they should
    read the file named: HACKING.

    Also, anyone wishing to hack Gtk# is encouraged to join the Gtk#
    mailing list. And to visit the #gtk# IRC channel (on irc.gnome.org).

NOTE: This file is out of date. Please refer to http://www.mono-project.com/GAPI for a more complete and up-to-date guide to the GAPI tools included with Gtk#


How to use the Gtk# code generator:

Install dependencies:

   * You need to install the XML::LibXML perl bindings and Gtk#.

Parse the library:

   * Create an xml file defining the libraries to be parsed. The
     format of the XML is:

	<gapi-parser-input>
	  <api filename="../api/atk-api.xml">
	    <library name="libatk-1.0-0.dll">
	      <namespace name="Atk">
	        <dir>atk-1.2.4/atk</dir>
	      </namespace>
	    </library>
	  </api>
	</gapi-parser-input>

     The api element filename attribute specifies the parser output file location.
     The name attribute on the library output points to the native library name. If
     you are creating a cross-platform project, you will want to specify the win32 dll
     name here and use mono's config mechanism to map the name on other platforms.
     The dir element points to a src directory to be parsed.  Currently all .c and .h
     files in the directory are parsed.

     All the elements inside the root can have multiples. The source/gtk-sharp-sources.xml
     file has examples of producing multiple api files with a single parser input file, as
     well as including muliple libraries in a single output file.

   * Create metadata rules files named <namespace>.metadata in the directory where you invoke
     the parser.  Metadata rules allow you to massage the parsed api if necessary.  Examples
     of rule formats can be found in the sources directory.

   * Execute the parser on your xml input file:
	gapi-parser <xml-input-filename>

   * Distribute the xml file(s) produced by the parser with your project so that your
     users don't need to have any native library source, or perl libraries installed in
     order to build your project.

Within your project directory, do the following:

   * Setup a toplevel subdirectory for each namespace/assembly you
     are wrapping. Instruct the makefile for this directory to compile,
     at minimum, generated/*.

   * Run gapi_codegen.exe on the API file(s) you created with the parser. If you depend
     on any other wrapped libraries (such as gtk-sharp.dll), you need to include their API
     listings via the --include directive.  The code generator, if successful, will have
     populated the assembly directories with generated/ directories. It is generally helpful
     to automate this process with makefiles. Gtk# uses the following organization:
        - sources/: Source directories, .sources listing, .metadata files.
             developers run make manually here when they want to update the API files.
        - api/: API files
             The files are committed to CVS and included in releases for the convenience
             of the lib user.  This dir is included in the build before the namespace dirs
             and the generator is invoked from this dir.