root/juggler/branches/2.2/modules/vapor/INSTALL.txt

Revision 12464, 5.2 kB (checked in by patrickh, 5 years ago)

Updated for minimum development tool requirements changes.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1 ==============================================================================
2 This file contains instructions on how to build the VR Juggler Portable
3 Runtime (VPR) from the source code.
4 ==============================================================================
5
6 ------------------
7 Table of contents:
8 ------------------
9
10     1. Getting started
11         A. Supported platforms
12         B. Minimum requirements (compiler, libraries, etc.)
13     2. Compiling the VR Juggler Portable Runtime
14         A. Steps
15         B. Options for the configure script
16         C. Advanced topics
17
18 ==============================================================================
19 1. Getting started
20 ==============================================================================
21
22     A. Supported platforms
23
24         VPR is officially supported on the following platforms:
25
26             IRIX 6.5
27             Red Hat Linux 6.1 and newer
28             Windows NT 4.0, 2000, and XP
29             Windows 98/Me
30
31         VPR is known to work on the following platforms (but is not
32         officially supported):
33
34             HP-UX 10.20 and 11.00
35             FreeBSD 4.x through 5.0-CURRENT (x86)
36             Sun Solaris 7 (x86)
37             Sun Solaris 8 (x86 and SPARC) with patches up through June 25, 2001
38             Mac OS X
39
40     B. Minimum requirements (by operating system)
41
42         * All
43             GNU make 3.78
44             GNU Autoconf 2.53
45             GNU Automake 1.4
46
47         * IRIX 6.5.3
48             MIPSpro Compilers 7.3.1.1m
49
50         * Red Hat Linux
51             GCC 3.0
52
53         * Windows NT 4.0
54             Microsoft Visual Studio 6.0 (SP4 or SP5)
55             Juggler Tools (http://www.vrjuggler.org/pub/juggler-tools.zip)
56             Cygwin 1.3.x including the Cygwin build of Perl
57
58         * HP-UX
59             aCC A.03.30
60
61         * Solaris
62             GCC 3.0 and GNU binutils 2.12
63               or
64             Sun WorkShop 6 update 2 C++ 5.3
65             Mesa3D 3.2
66
67         * FreeBSD
68             GCC 3.0
69
70         * Mac OS 10.0.3
71             Developer package
72
73 ==============================================================================
74 2. Compiling the VR Juggler Portable Runtime
75 ==============================================================================
76
77     A. Steps
78
79           i. Choose a directory to put the VR Juggler Portable Runtime source
80              code (referred to as <VPR_DIR> from now on).
81
82          ii. Go to that directory and checkout VR Juggler Portable Runtime
83              using CVS
84              NOTE: make sure CVS is set up, and pointing to the VR Juggler
85              Portable Runtime repository.
86
87             The simple version is:
88
89                 cd <VPR_DIR>
90                 cvs checkout vapor
91
92         iii. Enter the newly checked out VPR source directory
93
94                 cd <VPR_DIR>/vapor
95
96          iv. Compile the VR Juggler Portable Runtime (using the Autoconf
97              system and GNU make)
98
99               a. Generate aclocal.m4, header template (vprDefines.h.in), and
100                  the configure script
101
102                     ./autogen.sh
103    
104               b. Probe the system for capabilities, generate Makefiles, etc.
105                  (this configures the source tree for the current system)
106
107                     ./configure
108
109               c. Make the distribution using GNU make.  This compiles, links,
110                  and creates the final distribution tree (in the form of
111                  symlinks)
112
113                     gmake
114
115           v. Set the environment variable $VPR_BASE_DIR.  This is *required*
116              by VPR's application makefiles and runtime environment.
117
118              NOTES:
119                  1. The directory "instlinks" is semi-important.
120                     It is a working distribution of the VR Juggler Portable
121                     Runtime library.  After "gmake" is done, you'll be able
122                     to use this directory to compile and link your
123                     application code.  This will not work on Win32, so a
124                     full installation must be performed.
125                  2. It is helpful to have something similar to the following
126                     line your $HOME/.tcshrc or $HOME/.cshrc file (assuming
127                     the use of tcsh for your shell):
128
129                         setenv VPR_BASE_DIR [VPR_DIR]/vapor/instlinks
130
131                     Use whatever is appropriate for your shell (BASH, ksh,
132                     DOS, etc.)
133
134     B. Options for the configure script
135
136        To get a list of options that can be passed to the configure script,
137        execute the following in <VPR_DIR>/vapor:
138
139            ./configure --help
140
141     C. Advanced topics
142
143        Sending compiler output to a different directory than the source
144        tree can be helpful for debugging and development.  This is done
145        by making a directory to put the object files and compiled
146        libraries before building.
147
148        The following steps set up a build directory within your VR Juggler
149        Portable Runtime source directory.  Here, we use the name <BUILD_DIR>
150        to refer to the directory that will contain the object files and
151        libraries.  It can be called whatever you want.
152
153            mkdir <VPR_DIR>/vapor/<BUILD_DIR>
154            cd <VPR_DIR>/vapor/<BUILD_DIR>
155            <VPR_DIR>/vapor/configure
156
157 $Id$
Note: See TracBrowser for help on using the browser.