aboutsummaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2010-09-23 17:19:35 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2010-09-23 17:19:35 +0200
commit01e9cfc592c48e035f5280796f261ee97da52ead (patch)
treee8aaa26bf35b83f3ca2f40806e7e2fa378c492d6 /INSTALL
parent0a1552132435813f25c32c59bca2366e28a320da (diff)
Update INSTALL file, add to distribution
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL40
1 files changed, 18 insertions, 22 deletions
diff --git a/INSTALL b/INSTALL
index e156c46..9ec811f 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,16 +1,11 @@
-Prerequisites
-=============
-
- - C++ compiler
-
Building on UNIX
================
-The following build instructions are used for Linux/UNIX/MacOS X operating
-systems as well as for Cigwin and MinGW on Windows.
+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 package directory
+unpacking the source code archive, change to the libodb package directory
(referred to as libodb/ from now on) and run the configure script:
./configure
@@ -19,9 +14,9 @@ To see the available configuration options run configure with --help:
./configure --help
-Here is an example configure run that creates shared libraries only using
-the specified GNU C++ compiler with optimization and without the debug
-information:
+As an 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
@@ -29,7 +24,7 @@ Once configuration is complete, run make to build libodb:
make
-If the build completes successfully, you can install the libodb headers
+Once the build completes successfully, you can install the libodb headers
and libraries using the install target (you may need to do this step as
root depending on the installation directory):
@@ -39,14 +34,15 @@ make install
Building on Windows
===================
-The following build instructions are for Microsoft Visual Studio. If you
-would like to build libodb with GCC either using Cigwin or MinGW, refer
-to the "Building on UNIX" section above.
+The following build instructions are for Windows using Microsoft Visual
+Studio. If you would like to build libodb with GCC either using Cygwin
+or MinGW, refer to the "Building on UNIX" section above.
-To build libodb with Visual Studio unpacking the source code archive and
-open the libodb-vc<N>.sln file located in the libodb package directory
-(referred to as libodb\ from now on). Here N is the version of Visual
-Studio that you are using. Once the solution is open, select the desired
+The standard Visual Studio project and solution files are used on this
+platform. To build libodb, unpack the source code archive and open the
+libodb-vc<N>.sln file located in the libodb package directory (referred
+to as libodb\ 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.
@@ -56,18 +52,18 @@ libodb\bin\ and libodb\lib\ directories, respectively. Similarly, the
libodb\lib64\. The Release versions of import libraries are named
odb.lib and the Debug versions are named odb-d.lib.
-To configure Visual Sudio to automatically locate the libodb headers,
+To configure Visual Studio to automatically locate the libodb headers,
DLLs, and import libraries, add the following paths to your VC++
Directories:
Win32:
- Inlcude: ...\libodb
+ Include: ...\libodb
Library: ...\libodb\lib
Executable: ...\libodb\bin
x64:
- Inlcude: ...\libodb
+ Include: ...\libodb
Library: ...\libodb\lib64
Executable: ...\libodb\bin64