= libpipi development notes =

This page explains how to build and hack on libpipi.

== Getting the source code ==

The source code is managed in a Subversion repository. You can [/browser/libpipi/trunk browse it online] for a quick overview of what is happening.

Use the following command to retrieve the source code:

{{{
svn co svn://svn.zoy.org/caca/libpipi/trunk libpipi
}}}

== Building using the autotools ==

Using the autotools solution is the preferred way to build libpipi. It is complicated but you can trust us to maintain it properly. Building libpipi is then a 3-step operation: bootstrapping, configuring and building.

{{{
./bootstrap
./configure
make
}}}

This will build [wiki:libpipi], [wiki:thepimp The Pimp] and a few example programs.

== Developing using !MonoDevelop ==

[http://www.monodevelop.com/ MonoDevelop] is an IDE primarily targetting .NET. libpipi includes a !MonoDevelop solution because The Pimp makes use of its convenient interface builder, Stetic.

The `libpipi.mds` solution contains the following projects:
 * `libpipi.mdp`, which builds libpipi using the autotools solution under the hood
 * `pipi-sharp.mdp`, the libpipi .NET bindings
 * `ThePimp.mdp`

To build the libpipi examples or other programs, use the autotools solution.

'''Note''': if you add new files or widgets to the !MonoDevelop solution, try not to forget to edit `ThePimp/Makefile.am` accordingly.

== Developing using Visual Studio ==

A `libpipi.sln` Visual Studio solution is also provided, but not actively maintained. Its primary purpose is to debug libpipi and The Pimp on the Windows platform.

== Developing using Cygwin ==

The [http://www.cygwin.com/ Cygwin] environment is not supported. Let us know about your experience.