aboutsummaryrefslogtreecommitdiffstats
path: root/doc/howto-build/setup-generator.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/howto-build/setup-generator.rst')
-rw-r--r--doc/howto-build/setup-generator.rst50
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/howto-build/setup-generator.rst b/doc/howto-build/setup-generator.rst
new file mode 100644
index 000000000..c3f321c3c
--- /dev/null
+++ b/doc/howto-build/setup-generator.rst
@@ -0,0 +1,50 @@
+
+.. _generator-runner:
+
+****************
+Generator Runner
+****************
+
+Overview
+=========================================
+
+The **Generator Runner** (A.K.A. :program:`generatorrunner`) is the
+program that controls the binding generation process according to the
+rules given by the user through headers, type system files and generator
+front-ends (such as :ref:`boost-python-generator`). It depends on
+:ref:`api-extractor` library.
+
+
+Getting the sources
+===================
+
+* Download URL: http://www.pyside.org/downloads/
+
+Build requirements
+==================
+
++ CMake >= 2.6.0
++ Qt4.5 libraries and development headers >= 4.5.0
++ :ref:`api-extractor` + development headers
+
+Building and installing
+=======================
+
+To build and install just follow the generic cmake instructions in
+section :ref:`cmake-primer`.
+
+Debian packaging
+================
+
+In order to compile this package in a debian environment, make sure the
+following packages are installed:
+
+* debhelper (>= 5)
+* cdbs
+* cmake (>= 2.6.0)
+* libqt4-dev (>= 4.5)
+* libapiextractor-dev (>= 0.3.2)
+
+And then you can build the package using::
+
+ $ dpkg-buildpackage -rfakeroot