aboutsummaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2011-04-24 18:15:48 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2011-04-24 18:15:48 +0200
commit8fd6d24c09f9da4c65cd82ad1e6f56918ae669a3 (patch)
treecc601bbb0e1dc2c49ce4db21c407e1b6859d0063 /INSTALL
parent80ce07285129a954fde5a4ded824c8834f21a4d3 (diff)
Update installation instructions with Qt information
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL55
1 files changed, 37 insertions, 18 deletions
diff --git a/INSTALL b/INSTALL
index 4198144..9907f5a 100644
--- a/INSTALL
+++ b/INSTALL
@@ -7,11 +7,16 @@ system you would like to use. Valid values for <database> are:
Prerequisites
=============
+Required:
- odb http://www.codesynthesis.com/products/odb/
- libodb http://www.codesynthesis.com/products/odb/
- libodb-<database> http://www.codesynthesis.com/products/odb/
- - libodb-boost (optional) http://www.codesynthesis.com/products/odb/
- - boost (optional) http://www.boost.org
+
+Optional:
+ - libodb-boost http://www.codesynthesis.com/products/odb/
+ - Boost http://www.boost.org
+ - libodb-qt http://www.codesynthesis.com/products/odb/
+ - Qt http://qt.nokia.com
Building on UNIX
================
@@ -41,31 +46,35 @@ 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:
+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, libodb-<database>, and,
-if you would like to build the boost example, libodb-boost and boost
+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,
+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,
---with-libodb-<database>, --with-libodb-boost, and --with-boost
-configure options to specify their locations, for example:
+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 the boost build directory the configure script expects to find the
-boost libraries in the stage/lib/ subdirectory.
+If you would also like to build the boost example, then the configure
+script should be able to find headers and libraries for libodb-boost
+and Boost. Similarly, if you would like to build the qt example, then
+the configure script should be able to find headers and libraries for
+libodb-qt and Qt. The same mechanisms as described above can be used
+to specify locations of these libraries if they cannot be discovered
+automatically.
For each <database> value the configure script has a set of options in
the form --with-<database>-* that allow you to specify various database
@@ -100,12 +109,19 @@ 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, libodb-<database>,
-and, if you would like to build the boost example, libodb-boost and boost
+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 ODB library packages
-for more information on how to setup their VC++ Directories. For boost,
-refer to the boost documentation.
+for more information on how to setup their VC++ Directories.
+
+If you would also like to build the boost example, then the header and
+import library directories for libodb-boost and Boost must be in the VC++
+Directories Include and Library search lists. Similarly, if you would like
+to build the qt example, then the header and import library directories
+for libodb-qt and Qt must be in the VC++ Directories Include and Library
+search lists. See the INSTALL files in the ODB library packages for more
+information on how to setup their VC++ Directories. For Boost and Qt,
+refer to their documentation.
To build the examples, unpack the source code archive and open the
examples-<database>-vc<N>.sln file located in the odb-examples package
@@ -114,10 +130,13 @@ 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.
-If you would like to build the boost example (requires boost and
+If you would like to build the boost example (requires Boost and
libodb-boost), also open and build the solution in the boost/
subdirectory.
+If you would like to build the qt example (requires Qt and libodb-qt),
+also open and build the solution in the qt/ subdirectory.
+
Once the build is completed 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