~ubuntu-branches/debian/sid/coin2/sid

« back to all changes in this revision

Viewing changes to README.WIN32

  • Committer: Bazaar Package Importer
  • Author(s): Steve M. Robbins
  • Date: 2008-06-28 02:38:17 UTC
  • mfrom: (1.2.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20080628023817-lgrh0u677j1gcqgf
Tags: 2.5.0-2
* debian/control: Change suggests from libopenal0 to libopenal0a.
  Closes: #488001.  Change ${Source-Version} to ${binary:Version}.
  Update to standards version 3.8.0.

* debian/rules: Do not ignore errors in clean rule.

Show diffs side-by-side

added added

removed removed

Lines of Context:
7
7
 
8
8
The source code archive for Coin comes with Microsoft Visual Studio files
9
9
for building and installing the Coin library.  Visual Studio 6, Visual
10
 
Studio 7.1, and Visual Studio 8 are supported.  For 7.0, you need to upgrade
11
 
the 6 projects, but probably use the 7.1 config-*.h headers.
 
10
Studio 7.1, and Visual Studio 8 are supported.  For 7.0, you might need to
 
11
upgrade the 6 projects, but probably use the 7.1 config-*.h headers.
12
12
 
13
13
At the last stage of the build, the Coin development kit is automatically
14
14
installed into the directory the COINDIR environment variable points to.
16
16
 
17
17
  Control Panel => System => Advanced => Environment Variables
18
18
 
19
 
and make sure you create that directory before starting the build - if the
20
 
variable isn't set or the directory doesn't exist, the installation will
 
19
and make sure you create that directory before trying to install Coin - if
 
20
the variable isn't set or the directory doesn't exist, the installation will
21
21
break and you won't get a functional SDK.  Using the source hierarchy as
22
22
the SDK is not recommended - let Coin be installed, and use COINDIR from
23
23
your other projects that use Coin.
24
24
 
25
25
For Microsoft Visual Studio 6, you will find the complete build file setup
26
 
in the directory "build/msvc6/".  Open the dsw file.
 
26
in the directory "build/msvc6/".  Open the coin2.dsw file.
27
27
 
28
28
For Microsoft Visual Studio 7.1, you will find the complete build file
29
 
setup in the directory build/msvc7/.  Open the sln file.
 
29
setup in the directory build/msvc7/.  Open the coin2.sln file.
30
30
 
31
31
For Microsoft Visual Studio 8, you will find the complete build file setup
32
 
in the directory build/msvc8/.  Open the sln file.
 
32
in the directory build/msvc8/.  Open the coin2.sln file.
33
33
 
34
34
There are four different configurations in the project files.  DLL,
35
 
release and debug, and LIB, release and debug.  The LIB targets are new
36
 
as of july 2005 and hardly testet.  Consider them experimental until
37
 
this file says otherwise.  The static libraries you build with those
38
 
configurations are not installed at the end of the build process - only
39
 
the DLLs are installed (into COINDIR).  If you need to use the static
40
 
libraries, you need to copy them into COINDIR/lib manually, and also
41
 
make sure you set the COIN_NOT_DLL define in your other projects.
 
35
release and debug, and LIB, release and debug.
 
36
 
 
37
The workspace/solution is divided into several projects:
 
38
* The base "coin2"-project is for compiling the library.
 
39
* The "coin2_install"-project is for performing the installation procedure.
 
40
* The "coin2_uninstall"-project is for deleting the installed files again.
 
41
  Note that the Coin installation is fully contained inside COINDIR (no
 
42
  registry entries or any such things) so just deleting COINDIR is just
 
43
  as effective.
 
44
* The "coin2_docs"-project builds the Coin API reference documentation and
 
45
  places it in Coin\build\html\ (source hierarchy).  For this to work, you
 
46
  must install the Windows version of Doxygen (www.doxygen.org), preferably
 
47
  in the default C:\Program Files\doxygen\ location.
42
48
 
43
49
Tuning The Coin Library
44
50
-----------------------
45
51
 
46
52
There are certain settings you can adjust before building Coin to tune
47
53
Coin better for your intended usage.  All of these settings are contained
48
 
in the private header file "setup.h".  Read through and edit this file
49
 
manually if you think you ought to build Coin in a non-default way.  
 
54
in the private header file "setup.h" (in the "coin2"-project, look for
 
55
"Private Headers" / "[setup] headers" / "setup.h").  Read through and
 
56
edit this file manually if you think you ought to build Coin in a non-
 
57
default way.  
50
58
 
51
59
Warnings
52
60
--------
54
62
Be aware that the setups under the build/ directory may be out of sync with
55
63
the regular sources from time to time if you follow the source development
56
64
through CVS updates.  If this happens, it's just an oversight on our behalf.
57
 
Just notify coin-support@coin3d.org and they will be synchronized again
 
65
Just notify <coin-support@coin3d.org> and they will be synchronized again
58
66
within a day or two.
59
67
 
60
 
There are a couple of known problems with the project files:
61
 
- header files are listed multiple times (annoying, but harmless).
62
 
- there's no way to build without executing the subsequent installation
63
 
  step (you can disable the post-build rule, of course).
 
68
There are a couple of known issues with the project files:
 
69
- header files are in some places listed multiple times (annoying, but
 
70
  harmless).
 
71
- we build in Visual Studio 8.0 without the _CRT_NO_DEPRECATE define but
 
72
  have not resolved the issues with the "deprecations" yet, so there are
 
73
  a lot of warnings while building Coin.
64
74
 
65
75
Other IDEs
66
76
==========