README

NAME
    Alien::ODE - Build and make available ODE library - <http://ode.org/>

VERSION
    Version 0.001

SYNOPSIS
    Alien::ODE during its installation does one of the following:

    *   Builds *ODE* (The Open Dynamics Engine) binaries from source codes
        and installs dev files (headers: *.h, static library: *.a) into
        *share* directory of Alien::ODE distribution.

    *   Tries to locate an already installed ODE via 'ode-config' script.

    Later you can use Alien::ODE in your module that needs to link with
    *libode* like this:

        # Sample Build.pl
        use Module::Build;
        use Alien::ODE;

        my $build = Module::Build->new(
          module_name => 'Any::ODE::Module',
          # + other params
          build_requires => {
                        'Alien::ODE' => 0,
                        # + others modules
          },
          configure_requires => {
                        'Alien::ODE' => 0,
                        # + others modules
          },
          extra_compiler_flags => Alien::ODE->config('cflags'),
          extra_linker_flags   => Alien::ODE->config('libs'),
        )->create_build_script;

    NOTE: Alien::ODE is required only for building not for using
    'Any::ODE::Module'.

DESCRIPTION
    In short "Alien::ODE" can be used to detect and get configuration
    settings from an already installed ODE. It offers also an option to
    download ODE source codes and build binaries from scratch.

METHODS
  config()
    This function is the main public interface to this module. Basic
    functionality works in a very similar maner to 'ode-config' script:

        Alien::ODE->config('prefix');   # gives the same string as 'ode-config --prefix'
        Alien::ODE->config('version');  # gives the same string as 'ode-config --version'
        Alien::ODE->config('libs');     # gives the same string as 'ode-config --libs'
        Alien::ODE->config('cflags');   # gives the same string as 'ode-config --cflags'

BUGS
    Please post issues and bugs at
    <https://github.com/PerlGameDev/Alien-ODE/issues>

AUTHOR
    KMX, <kmx at cpan.org>

COPYRIGHT
    This program is free software; you can redistribute it and/or modify it
    under the same terms as Perl itself.

    The full text of the license can be found in the LICENSE file included
    with this module.