
* How To Wrap A GTK Library *
-----------------------------

This documentation has only just begun.
I will update it when the structure is complete, so don't worry about changing 
he structure so that this is no longer true.
Feel free to add to it.

The project structure (AKA 'Autoconf/Automake stuff')
-----------------------------------------------------

Assuming that your project will be called GtkSomething--, and that it wraps a 
library called Gtk+Something, then you should be able to construct it by 
following these instructions.

- Copy the 'GtkExtra--' project directory, and rename it to 'GtkSomething--'.
- Rename the 'gtkextra--' sub-directory to 'gtksomething--'
- Edit the top-level configure.in:
    - Set the GENERIC variables appropriately (in the user sections).
    - Modify the AC_OUTPUT arguments so that they use the 'gtksomething--' 
      path instead of 'gtkextra--'.
    - Adapt the library tests (probably remove AC_PATH_GTKEXTRA) to your needs
- In the gtksomething-- directory:
    - Remove the GtkExtra-- *.gen_h files.
    - Edit Makefile.am and change the name of the library 
      (libgtkextra to libgtksometing) in the last section.
    - Rename gtkextra--.h and gtkextra--.cc to gtksomething.h and 
      gtksomething.cc. Edit those files and adapt them to your library 
      (or leave them empty if you don't need them - they are required by 
      automake). 
    - Add your own *_gen.h files (See below):
- Remove the examples, and add your own, adapting the simple Makefile.am file 
  for your own sources.
- Put your own documentation in the 'docs' directory, making appropriate
  changes to the EXTRA_DIST variable in that Makefile.am.
- run autogen.sh to build your project.

Writing the .gen_h files
------------------------

Now read the 'Using_gtkmmproc' document.

Place your .gen_h files in your gtksomething-- directory.  

Creating your distribution
--------------------------

Type 'make dist' create your distribution. This will build a tar.gz file from your sources. Users can then expand that file and simply run './configure', then 'make' to build your library.
  
Murray Cumming <murrayc@usa.net>
Cedric Gustin <gustin@pcpm.ucl.ac.be>
