From 497e3dbc0f8960fbd57d2d51dffdfe5b008e7774 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Thu, 23 Sep 2010 17:20:00 +0200 Subject: Add INSTALL file --- INSTALL | 103 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ makefile | 2 +- 2 files changed, 104 insertions(+), 1 deletion(-) create mode 100644 INSTALL diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..81518a9 --- /dev/null +++ b/INSTALL @@ -0,0 +1,103 @@ +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.sln file located in the libodb-mysql package +directory (referred to as libodb-mysql\ from now on). Here 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 diff --git a/makefile b/makefile index 973d042..943ccc7 100644 --- a/makefile +++ b/makefile @@ -14,7 +14,7 @@ clean := $(out_base)/.clean $(default): $(addprefix $(out_base)/,$(addsuffix /,$(dirs))) $(dist): export dirs := $(dirs) -$(dist): export docs := GPLv2 LICENSE README NEWS version +$(dist): export docs := GPLv2 LICENSE README INSTALL NEWS version $(dist): data_dist := libodb-mysql-vc9.sln libodb-mysql-vc10.sln $(dist): exec_dist := bootstrap $(dist): export extra_dist := $(data_dist) $(exec_dist) -- cgit v1.1