<%include file="navigation.html"/>

## Use The Source!

K-3D is Free Software. The source code is licensed using the GNU General Public License.

K-3D is written in C++ with platform independence in mind. As a result, K-3D can be built on GNU/Linux, MacOS X, FreeBSD, Microsoft Windows, and other platforms.

We use Mercurial for source-code management, CMake for our build system, and gtkmm for our user interface toolkit. Required dependencies include Boost, OpenGL, and libsigc++.

K-3D can be optionally built with integration for Collada, DBus, GLX, Gnome VFS, GTS, ImageMagick, ODE, OpenCASCADE, OpenEXR, and more ...

## Quick Start

Clone the K-3D sources and build:

    $ hg clone http://k3d.hg.sf.net/hgweb/k3d/k3d
    $ mkdir k3d-build
    $ cd k3d-build
    $ cmake ../k3d
    $ make

Run K-3D from the build directory:

    $ cd k3d-build
    $ make run/fast

Install K-3D:

    $ cd k3d-build
    $ make install

Make changes to the K-3D sources:

    $ cd k3d
    $ (edit files)
    $ hg add (new files)
    $ hg rm (files to be deleted)
    $ hg commit -m 'My changes'

Create a patch from the most recent commit:

    $ cd k3d
    $ hg export tip > my.patch

For more on using Mercurial see the guide.