<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
	<head>
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
		<title>K-3D Developer</title>
		<link rel="icon" type="image/png" href="k3d.png" />
		<link rel="stylesheet" type="text/css" href="k3d.css" />
		<link rel="stylesheet" type="text/css" href="developer.css" />
	</head>

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

		<div id="main">
			<div id="left">
				<h2>Use The Source!</h2>
				<p>K-3D is <a href="http://www.gnu.org/philosophy/free-sw.html">Free Software</a>.  The source code
				is licensed using the <a href="http://www.gnu.org/licenses/gpl-faq.html">GNU General Public License</a>.</p>

				<p>K-3D is written in C++ with platform independence in mind.
				As a result, K-3D can be built on
				<a href="http://www.linux.org">GNU/Linux</a>,
				<a href="http://www.apple.com">MacOS X</a>,
				<a href="http://www.freebsd.org/">FreeBSD</a>,
				<a href="http://www.microsoft.com/windows">Microsoft Windows</a>,
				and other platforms.</p>

				<p>We use <a href="http://git-scm.com/">Git</a> for source-code management,
				<a href="http://cmake.org">CMake</a> for our build system, and <a href="http://gtkmm.org">gtkmm</a>
				for our user interface toolkit.  Required dependencies include <a href="http://boost.org">Boost</a>,
				<a href="http://opengl.org">OpenGL</a>, and <a href="http://libsigc.sourceforge.net">libsigc++</a>.
				</p>
				<p>K-3D can be optionally built with integration for Collada, DBus, GLX, Gnome VFS, GTS, ImageMagick,
				ODE, OpenEXR, and more ...
				</p>
			</div>

			<div id="right">
				<h2>Quick Start</h2>

				<p><em>Clone the K-3D sources and build:</em>
<pre>
$ git clone git://github.com/K-3D/k3d.git
$ mkdir k3d-build
$ cd k3d-build
$ cmake ../k3d
$ make
</pre>
				</p>

				<p><em>Run K-3D from the build directory:</em>
<pre>
$ cd k3d-build
$ make run/fast
</pre>
				</p>

				<p><em>Install K-3D:</em>
<pre>
$ cd k3d-build
$ make install
</pre>
				</p>
				<p><em>Make changes to the K-3D sources:</em></p>
				<p>
				<ol>
					<li>Create a <a href="http://help.github.com/fork-a-repo/">fork</a> on Github</li>
					<li><a href="http://book.git-scm.com/3_normal_workflow.html">commit the changes</a></li>
					<li><a href="http://help.github.com/send-pull-requests/">send a pull request</a></li>
				</ol>
				You can also just create a patch, if needed.
				</p>

				<p><em>For more on using Git see the <a href="http://book.git-scm.com/">guide</a>.</em></p>

			</div>
		</div>

		<script type="text/javascript" src="http://www.google-analytics.com/ga.js"/>
		<script type="text/javascript">
			try { var pageTracker = _gat._getTracker("UA-3773195-5"); pageTracker._trackPageview(); } catch(err) { }
		</script>
	</body>
</html>
