diff options
| -rw-r--r-- | INSTALL | 123 | ||||
| -rw-r--r-- | makefile | 2 |
2 files changed, 124 insertions, 1 deletions
@@ -0,0 +1,123 @@ +In this document we use <database> as the name of the database system you +would like to use. Valid values for <database> are: + + 'mysql' - The MySQL database system + +Prerequisites +============= + + - odb http://www.codesynthesis.com/products/odb/ + - libodb http://www.codesynthesis.com/products/odb/ + - libodb-<database> http://www.codesynthesis.com/products/odb/ + +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 odb-examples +package directory (referred to as odb-examples/ from now on) and run +the configure script, for example: + +./configure --database <database> + +To see the available configuration options run configure with --help: + +./configure --help + +The required --database option specify the database system you would +like to use. + +The configure script expects the directory where the ODB compiler +binary is installed to be in the executable search path (the PATH +environment variable). If that's not the case, you can use the ODB +configure variable to specify the path to the ODB compiler, for +example: + +./configure ODB=/opt/odb/bin/odb + +If the ODB compiler is not installed and you would like to run it +from its build directory instead, you can use the --with-odb configure +option to specify the build directory, for example: + +./configure --with-odb=/tmp/odb + +The configure script also expects the libodb and libodb-<database> +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 these libraries are not installed and you would like to use their +build directories instead, you can use the --with-libodb and +--with-libodb-<database> configure options to specify their locations, +for example: + +./configure --with-libodb=/tmp/libodb + +For each <database> value the configure script has a set of options in +the form --with-<database>-* that allow you to specify various database +system parameters, such as the login name, password, and database name, +that should be used when running the examples. Run configure with +--help to see the available options for your database. + +As another example, the following configure command uses the specified +C++ compiler and compiles with optimization and without the debug +information: + +./configure CXX=g++-4.5 CXXFLAGS=-O3 + +Once configuration is complete, run make to build the examples: + +make + +Once the build completes successfully, you can run each example manually +from the command line. See the README file accompanying each example +for more information on how to do this. Alternatively, you can run all +the examples using the check target: + +make check + + +Building on Windows +=================== + +The following build instructions are for Windows using Microsoft Visual +Studio. If you would like to build odb-examples 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 directory where the ODB +compiler binary is installed to be in the executable search path (the +PATH environment variable). They also expect the libodb and +libodb-<database> header and import library directories to be in the +VC++ Directories Include and Library search lists. See the INSTALL +files in the library packages for more information on how to setup +the VC++ Directories. + +To build the examples, unpack the source code archive and open the +examples-<database>-vc<N>.sln file located in the odb-examples package +directory (referred to as odb-examples\ 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. + +Once the build completes successfully, you can run each example manually +from the command line. See the README file accompanying each example +for more information on how to do this. Alternatively, you can run all +the examples using the test.bat batch file located in the odb-examples\ +directory. + +Before you can run test.bat, you may need to adjust the database system +parameters, such as the login name, password, and database name, that +should be used when running the examples. To do this edit the +<database>.options and <database>-driver.bat files located in the +odb-examples\ directory. Once this is done you can run the examples by +executing the following command from the command prompt: + +test.bat <database> @@ -17,7 +17,7 @@ $(default): $(addprefix $(out_base)/,$(addsuffix /,$(dirs))) $(dist): name := examples $(dist): export dirs := $(dist_dirs) -$(dist): data_dist := GPLv2 LICENSE README NEWS version tester.bat \ +$(dist): data_dist := GPLv2 LICENSE README NEWS INSTALL version tester.bat \ mysql-driver.bat mysql.options $(dist): exec_dist := bootstrap tester $(dist): export extra_dist := $(data_dist) $(exec_dist) test.bat \ |