~ubuntu-branches/debian/jessie/libccd/jessie

« back to all changes in this revision

Viewing changes to doc/compile-and-install.rst

Committer: Package Import Robot
Author(s): Jose Luis Rivero
Date: 2014-03-24 16:51:48 UTC
Revision ID: package-import@ubuntu.com-20140324165148-mfno979f58rv322z

Tags: upstream-2.0

Import upstream version 2.0

files added:

.gitignore

BSD-LICENSE

CMakeLists.txt

Makefile.am

README

bootstrap

ccd.pc.in

configure.ac

doc/Makefile

doc/_build

doc/_build/.dir

doc/_static

doc/_static/.dir

doc/_templates

doc/_templates/.dir

doc/compile-and-install.rst

doc/conf.py

doc/examples.rst

doc/index.rst

doc/reference.rst

make-release.sh

src/.gitignore

src/Makefile

src/Makefile.am

src/Makefile.include

src/alloc.h

src/ccd

src/ccd.c

src/ccd/ccd.h

src/ccd/compiler.h

src/ccd/config.h.cmake.in

src/ccd/config.h.m4

src/ccd/quat.h

src/ccd/vec3.h

src/dbg.h

src/list.h

src/mpr.c

src/polytope.c

src/polytope.h

src/simplex.h

src/support.c

src/support.h

src/testsuites

src/testsuites/.gitignore

src/testsuites/Makefile

src/testsuites/Makefile.am

src/testsuites/bench.c

src/testsuites/bench2.c

src/testsuites/boxbox.c

src/testsuites/boxbox.h

src/testsuites/boxcyl.c

src/testsuites/boxcyl.h

src/testsuites/common.c

src/testsuites/common.h

src/testsuites/cu

src/testsuites/cu/.dir

src/testsuites/cu/.gitignore

src/testsuites/cu/COPYING

src/testsuites/cu/COPYING.LESSER

src/testsuites/cu/Makefile

src/testsuites/cu/Makefile.am

src/testsuites/cu/check-regressions

src/testsuites/cu/cu.c

src/testsuites/cu/cu.h

src/testsuites/cu/latest.sh

src/testsuites/cylcyl.c

src/testsuites/cylcyl.h

src/testsuites/main.c

src/testsuites/mpr_boxbox.c

src/testsuites/mpr_boxbox.h

src/testsuites/mpr_boxcyl.c

src/testsuites/mpr_boxcyl.h

src/testsuites/mpr_cylcyl.c

src/testsuites/mpr_cylcyl.h

src/testsuites/polytope.c

src/testsuites/polytope.h

src/testsuites/regressions

src/testsuites/regressions/.dir

src/testsuites/regressions/TSBoxBox.err

src/testsuites/regressions/TSBoxBox.out

src/testsuites/regressions/TSBoxCyl.err

src/testsuites/regressions/TSBoxCyl.out

src/testsuites/regressions/TSCylCyl.err

src/testsuites/regressions/TSCylCyl.out

src/testsuites/regressions/TSMPRBoxBox.err

src/testsuites/regressions/TSMPRBoxBox.out

src/testsuites/regressions/TSMPRBoxCyl.err

src/testsuites/regressions/TSMPRBoxCyl.out

src/testsuites/regressions/TSMPRCylCyl.err

src/testsuites/regressions/TSMPRCylCyl.out

src/testsuites/regressions/TSPt.err

src/testsuites/regressions/TSPt.out

src/testsuites/regressions/TSSphereSphere.err

src/testsuites/regressions/TSSphereSphere.out

src/testsuites/regressions/TSVec3.err

src/testsuites/regressions/TSVec3.out

src/testsuites/spheresphere.c

src/testsuites/spheresphere.h

src/testsuites/support.c

src/testsuites/support.h

src/testsuites/vec3.c

src/testsuites/vec3.h

src/vec3.c

Show diffs side-by-side

added added

removed removed

doc/compile-and-install.rst

Compile And Install

====================

libccd contains several mechanisms how to compile and install it.

Using a simple Makefile, using autotools and using CMake.

1. Using Makefile

------------------

Directory ``src/`` contains Makefile that should contain everything needed for compilation and installation:

.. code-block:: bash

$ cd src/

$ make

$ make install

Library libccd is by default compiled in double precision of floating point

numbers - you can change this by options ``USE_SINGLE``/``USE_DOUBLE``, i.e.:

.. code-block:: bash

$ make USE_SINGLE=yes

will compile library in single precision.

Installation directory can be changed by options ``PREFIX``, ``INCLUDEDIR``

and ``LIBDIR``.

For more info type '``make help``'.

2. Using Autotools

-------------------

libccd also contains support for autotools:

Generate configure script etc.:

.. code-block:: bash

$ ./bootstrap

Create new ``build/`` directory:

.. code-block:: bash

$ mkdir build && cd build

Run configure script:

.. code-block:: bash

$ ../configure

Run make and make install:

.. code-block:: bash

$ make && make install

configure script can change the way libccd is compiled and installed, most

significant option is ``--enable-double-precision`` which enables double

precision (single is default in this case).

3. Using CMake

---------------

TODO

Older »