Changeset 18920

Timestamp:

05/30/06 15:50:29 (2 years ago)

Author:

patrick

Message:

Regen.

Files:

• juggler/trunk/INSTALL.html (modified) (8 diffs)
• juggler/trunk/INSTALL.txt (modified) (4 diffs)

juggler/trunk/INSTALL.html

@@ -2 +2 @@
-      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-   <title>Building and Installing the Juggler Project (Version
-69
-32 Users</a></span></dt></dl></dd><dt><span class="section"><a href="#source.code.section">Getting the Source Code and the Dependencies</a></span></dt><dd><dl><dt><span class="section"><a href="#section.cvs.access">How to Get the Juggler Suite from CVS</a></span></dt><dt><span class="section"><a href="#d0e218">Downloading Third-Party Dependencies</a></span></dt></dl></dd><dt><span class="section"><a href="#compile.section">Compiling</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e304">Important Note Regarding Compiling</a></span></dt><dt><span class="section"><a href="#d0e315
+70
+dows Users</a></span></dt></dl></dd><dt><span class="section"><a href="#source.code.section">Getting the Source Code and the Dependencies</a></span></dt><dd><dl><dt><span class="section"><a href="#section.cvs.access">How to Get the Juggler Suite from CVS</a></span></dt><dt><span class="section"><a href="#d0e218">Downloading Third-Party Dependencies</a></span></dt></dl></dd><dt><span class="section"><a href="#compile.section">Compiling</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e310">Important Note Regarding Compiling</a></span></dt><dt><span class="section"><a href="#d0e321
-         Suite</a></span></dt></dl></dd></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e15"></a>Introduction</h2></div></div></div><p>You have downloaded the source code for Version 2.1 of the Juggler
-      Project. This is the code that will become VR Juggler 2.2, and it is the
@@ -68 +68 @@
-            for free. When configuring the source with
-            <span><strong class="command">configure.pl</strong></span> (described later), use the option
-32
+dows
-         supported by Visual Studio 6.0. Microsoft <a href="http://support.microsoft.com/default.aspx?scid=http://support.microsoft.com:80/support/kb/articles/q243/4/51.asp&amp;NoWebContent=1" target="_top">acknowledges</a>
-         the issues concerning noncompliance to the C++ Standard with Visual
@@ -127 +127 @@
-            Note that you need the command <span><strong class="command">bjam</strong></span> (referred
-            to as &#8220;<span class="quote">boost-jam</span>&#8221; on the Boost download page) to
-
+
+
-            and binary distributions for some platforms can be downloaded from
-            <a href="http://www.sf.net/projects/xml-cppdom/" target="_top">http://www.sf.net/projects/xml-cppdom/</a>.
@@ -133 +134 @@
-            must compile and install CppDOM yourself. Note that you need SCons
-            (<a href="http://scons.sourceforge.net/" target="_top">http://scons.sourceforge.net/</a>)
-1
+7
-            newer. The source distribution can be downloaded from <a href="http://www.sf.net/projects/ggt/" target="_top">http://www.sf.net/projects/ggt/</a>.
-            Note that you need SCons (<a href="http://scons.sourceforge.net/" target="_top">http://scons.sourceforge.net/</a>)
-2
+8
-            for operating system primitives. On some platforms (IRIX, FreeBSD,
-            Linux, Mac OS X), the use of NSPR is strictly optional. On others
@@ -142 +143 @@
-            system, you should decide whether you need NSPR. Binary versions
-            of NSPR can be downloaded from <a href="ftp://ftp.mozilla.org/pub/mozilla.org/nspr/releases" target="_top">ftp://ftp.mozilla.org/pub/mozilla.org/nspr/releases</a>.
-0
+6
-            C++. Java is used exclusively for GUIs such as Tweek and VRJConfig
-            (which is a JavaBean that is loaded into Tweek). To compile the
-            Java code, a JDK is necessary. We currently require version 1.4 or
-            newer. The Java Standard Edition can be downloaded from <a href="http://java.sun.com/j2se/" target="_top">http://java.sun.com/j2se/</a>.
-1
+7
-            in order to compile the Tweek C++ API. At this time, the Tweek C++
-            API is not required for VR Juggler, but this situation will change
@@ -159 +160 @@
-            configure script where to find everything. Please refer to <a href="#tweek.build.section" title="Tweek">the section called &#8220;Tweek&#8221;</a> for more details on this.</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="compile.section"></a>Compiling</h2></div></div></div><p>In this section, we describe how to compile the Juggler Project.
-      We focus on VR Juggler as a whole, but information about some of the
-04
+10
-         may not be stable, and it may not even compile. Compiling VR Juggler
-         itself can be a little complicated for anyone who does not have some
-         background in using CVS, Autoconf, C++, and <span><strong class="command">make</strong></span>
-15
+21
-         the tools that make up VR Juggler. Each tool compiles to its own
-         library and can be installed individually. (Refer to the
@@ -170 +171 @@
-         solution. After getting the dependencies needed to compile VR Juggler
-         (see the next section), refer to the <a href="README-WINDOWS.html" target="_top">README-WINDOWS.html</a> file located in
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-            configured. The Juggler Suite makes use of the well-known, widely
-            used GNU tools Autoconf and GNU Make. We provide a wrapper script
@@ -254 +325 @@
-               has information on more advanced uses of
-               <span><strong class="command">configure.pl</strong></span> that are beyond the scope of
-49
+75
-               Juggler depends on several external software packages. As an
-               example, consider the case where the GMTL library is installed

juggler/trunk/INSTALL.txt

@@ -18 +18 @@
-        Important Notes for IRIX Users
-
-32
+dows
-
-
@@ -136 +136 @@
-
-
-32
+dows
-
- VR Juggler 1.1 and newer use a lot of C++ features not supported by Visual
@@ -242 +242 @@
-
-
+Important
+
+ Mac OS X users should compile the Boost libraries using the
+ "darwin" toolset.
+
+
-CppDOM
-
@@ -323 +329 @@
- section), refer to the README-WINDOWS.html file located in this directory.
- Do not bother to the rest of this document.
+
+
+Per-Module Dependencies
+
+ Here, we provide per-module dependency information. Given that the
+ dependencies for any single module are met, the modules may be reused
+ effectively outside the scope of immersive VR application development.
+ Below, we list the minimum required version for each dependency, and where
+ appropriate, we note which dependencies are optional.
+
+
+VPR
+
+ VPR provides a cross-platform, object-oriented operating system
+ abstraction. It is the foundation for all other Juggler modules.
+
+
+*  CppDOM 0.3.2
+
+*  Boost headers and Boost.Filesystem 1.31.0
+
+*  NSPR (Windows, Solaris, and HP-UX only) 4.4
+
+
+
+Tweek C++ API
+
+ Tweek implements a distributed model/view/controller system on top of
+ CORBA. The Tweek C++ API provides the C++ component of that system. Code
+ written on top of the Tweek C++ API normally acts as the model piece of the
+ distributed model/view/controller system.
+
+
+*  VPR
+
+*  omniORB 4.0
+
+
+
+Tweek Java API
+
+ Tweek implements a distributed model/view/controller system on top of
+ CORBA. The Tweek Java API provides the Java component of that system. The
+ main part of the Tweek Java API is the Tweek JavaBean Loader, a GUI
+ application that loads Tweek Beans that normally function as the view and
+ controller pieces of the distributed module/view/controller system.
+
+
+*  J2SE SDK 1.4
+
+*  JDOM (included with Juggler source)
+
+*  Ant (included with Juggler source)
+
+*  JacORB IDL-to-Java compiler (included with Juggler source)
+
+
+
+Tweek Python API
+
+ Tweek implements a distributed model/view/controller system on top of
+ CORBA. The Tweek Python API provides the Python component of that system.
+ The main part of the Tweek Java API is the unfinished TweekQt GUI, an
+ application that loads Python modules that normally function as the view
+ and controller pieces of the distributed module/view/controller system.
+
+
+*  Python 2.3
+
+*  omniORBpy 2.0
+
+
+
+JCCL C++ API
+
+ The JCCL C++ API provides an interface for loading XML-based
+ configurations. It includes the run-time reconfiguration feature of
+ Juggler.
+
+
+*  VPR
+
+
+
+JCCL Java API
+
+ The JCCL Java API provides a programming interface for editing Juggler
+ configuration files and config definition files as well as JavaBeans for
+ editing these files using a graphical interface.
+
+
+*  Tweek Java API
+
+*  TableLayout package (included with Juggler source)
+
+
+
+JCCL Remote Run-Time Reconfiguration Plug-in (C++)
+
+ The C++ JCCL Remote Run-Time Reconfiguration Plug-in is an optional
+ extension to the JCCL Config Manager for allowing remote manipulation of a
+ Juggler configuration at run time based on Tweek.
+
+
+*  Tweek C++ API
+
+
+
+JCCL Remote Run-Time Reconfiguration Plug-in (Java)
+
+ The Java JCCL Remote Run-Time Reconfiguration Plug-in is an optional
+ extension that provides the features needed for a Java-based editor to
+ communicate with the C++ Remote Run-Time Reconfiguration Plug-in to edit
+ Juggler configurations live.
+
+
+*  Tweek Java API
+
+
+
+Sonix
+
+ Sonix is an abstraction layer for positional sound software. Sonix itself
+ cannot play audio, but it includes plug-ins based on popular interfaces for
+ playing audio. Each plug-in depends on a specific audio software library.
+
+
+*  VPR
+
+*  GMTL 0.1.9
+
+
+
+Sonix OpenAL Plug-in
+
+
+*  Sonix
+
+*  OpenAL
+
+*  Free ALUT
+
+
+
+Sonix Audiere Plug-in
+
+
+*  Sonix
+
+*  Audiere
+
+
+
+Sonix AudioWorks Plug-in
+
+
+*  Sonix
+
+*  AudioWorks
+
+
+
+Gadgeteer
+
+ Gadgeteer handles all input devices that can be used by VR Juggler
+ applications.
+
+
+*  VPR
+
+*  JCCL
+
+*  GMTL 0.1.9
+
+*  X Window System (non-Windows platforms)
+
+
+
+Gadgeteer Device Driver Plug-ins
+
+ The device driver plug-ins for Gadgeteer are independent components that
+ are discovered and used at run time based on the application configuration.
+ Drivers with dependencies are optional.
+
+
+*  Gadgeteer
+
+*  VRPN 06.06 for the VRPN driver plug-in
+
+*  TrackD API 4 for the TrackD API driver plug-in
+
+*  Microsoft Speech API for the MS Speech API driver plug-in
+
+
+
+Gadgeteer Cluster Plug-ins
+
+ The cluster plug-ins extend the functionality of the clustering
+ infrastructure built into Gadgeteer.
+
+
+*  Gadgeteer
+
+
+
+VR Juggler
+
+ The VR Juggler module is the unifying piece that pulls all the other
+ Juggler modules together. It provides a virtual platform for VR application
+ development. Real-time rendering is controlled by Draw Managers. The OpenGL
+ Performer Draw Manager is optional.
+
+
+*  Gadgeteer
+
+*  Sonix
+
+*  OpenGL
+
+*  OpenGL Performer for the optional OpenGL Performer Draw Manager
+
+
+
+VR Juggler Run-Time Performance Monitoring Plug-in (C++)
+
+ The C++ VR Juggler Run-Time Performance Monitoring Plug-in provides an
+ optional extension to VR Juggler for remote visualization of performance
+ metrics that are captured while running a VR Juggler application.
+ Communication is performed using the Tweek C++ API on top of CORBA.
+
+
+*  Tweek C++ API
+
+*  VR Juggler
+
+
+
+VR Juggler Run-Time Performance Monitoring Plug-in (Java)
+
+ The Java VR Juggler Run-Time Performance Monitoring Plug-in is an optional
+ extension that provides the features needed for Java-based visualization of
+ performance data collected while a VR Juggler application is running. This
+ is another JavaBean handled by the Tweek JavaBean Loader, and it uses CORBA
+ to communicate with the C++ VR Juggler Run-Time Performance Monitoring
+ Plug-in.
+
+
+*  JCCL Java API
+
+*  JFreeChart (included with Juggler source)
+
+
+
+VRJConfig
+
+ VRJConfig is the graphical editor for Juggler configurations. It is a
+ JavaBean loaded by the Tweek JavaBean Loader, and it makes use of the
+ editor Beans provided by the JCCL Java API.
+
+
+*  JCCL Java API
+
+*  JGraph (included with Juggler source)
+
-
-