Prerequisites
=============

  - libodb           http://www.codesynthesis.com/products/odb/
  - libmysqlclient   http://dev.mysql.com/downloads/mysql/


Building on UNIX
================

The following build instructions are for the Linux/UNIX/Mac OS X
operating systems as well as for Cygwin and MinGW on Windows.

The standard autotools-based build system is used on these platforms. 
After unpacking the source code archive, change to the libodb-mysql
package directory (referred to as libodb-mysql/ from now on) and run
the configure script:

./configure

To see the available configuration options run configure with --help:

./configure --help

The configure script expects the libodb and libmysqlclient headers
and libraries to be installed in a directory where the C++ compiler
and linker will search for them by default (normally /usr and 
/usr/local). If these libraries are installed in other directories,
you can use the CPPFLAGS and LDFLAGS configure variables to specify
their locations, for example:

./configure CPPFLAGS=-I/opt/libodb/include LDFLAGS=-L/opt/libodb/lib

If libodb is not installed and you would like to use its build
directory instead, you can use the --with-libodb configure option
to specify its location, for example:

./configure --with-libodb=/tmp/libodb

As another example, the following configure command only builds shared
libraries, uses the specified C++ compiler, and compiles with optimization
and without the debug information:

./configure --disable-static CXX=g++-4.5 CXXFLAGS=-O3

Once configuration is complete, run make to build libodb-mysql:

make

Once the build completes successfully, you can install the libodb-mysql
headers and libraries using the install target (you may need to do this
step as root depending on the installation directory):

make install


Building on Windows
===================

The following build instructions are for Windows using Microsoft Visual
Studio. If you would like to build libodb-mysql with GCC either using
Cygwin or MinGW, refer to the "Building on UNIX" section above.

The standard Visual Studio project and solution files are used on this
platform. The provided project files expect the libodb and libmysqlclient
header and import library directories to be in the VC++ Directories
Include and Library search lists. For libodb, see the INSTALL file in
the package directory for more information on how to setup the VC++
Directories.

For libmysqlclient, add the include\ directory inside the MySQL package
to the Include search list and the lib\opt\ directory to the Library
search list.

To build libodb-mysql, unpack the source code archive and open the
libodb-mysql-vc<N>.sln file located in the libodb-mysql package
directory (referred to as libodb-mysql\ from now on). Here <N> is the
version of Visual Studio that you are using. Once the solution is open,
select the desired build configuration (Debug or Release) and platform
(Win32 or x64) and build the solution.

The resulting 32-bit DLLs and import libraries are placed into the 
libodb-mysql\bin\ and libodb-mysql\lib\ directories, respectively.
Similarly, the 64-bit DLLs and import libraries are placed into
libodb-mysql\bin64\ and libodb-mysql\lib64\. The Release versions of
import libraries are named odb-mysql.lib and the Debug versions are
named odb-mysql-d.lib.

To configure Visual Studio to automatically locate the libodb-mysql
headers, DLLs, and import libraries, add the following paths to your
VC++ Directories:

Win32:

  Include:    ...\libodb-mysql
  Library:    ...\libodb-mysql\lib
  Executable: ...\libodb-mysql\bin    

x64:

  Include:    ...\libodb-mysql
  Library:    ...\libodb-mysql\lib64
  Executable: ...\libodb-mysql\bin64