The Juggler Project

Table of Contents

I. Introduction

1. Welcome

Required Reading

Introduction to the Juggler Development Team

2. Background Information

Required Reading

VR Juggler Virtual Platform: Mission Statement

II. Compiling and Installing

3. Build Systems

Required Tools and Utilities for Building VR Juggler from Source

4. Get the Source

Introduction

Getting the Source Code from the CVS Repository

Getting a Snapshot of the Source Code

5. VR Juggler Build System

Introduction

Sections

Compiling VR Juggler Libraries: Quick Start

Step by step build of the Juggler distribution

Win32 Compiling and Development Issues

Necessary Tools

Environment Variables

Compiling VR Juggler

Known Problems

6. Using the VR Juggler Configure Script

General Quick Start

Autoconf and Autoheader

Usage

Environment Variables (UNIX vs. Win32)

Quick Start

Options

Regenerating Files

When to Run configure Again

Advanced Use

Debugging Configuration Errors

Template (.in) Files

7. Compiling VR Juggler

General Quick Start

Targets

Useful Variables

GNU Make Options

Process of Building (Individual Steps)

Developer Installation

8. Installing VR Juggler

General Quick Start

Targets

Useful Variables

Process of Full Install (Individual Steps)

Custom Scripts

mtree(1) and mtree.pl

install-dir.pl

install-src.pl

makefiles-gen.pl

InstallOps Perl Module

9. Maintaining and Extending the Build System

III. User Community

10. Contributing to VR Juggler

Reasons to Contribute

Why is VR Juggler cool, why do I care?

Why Should I, an Intelligent, Helpful Person, Contribute to the Development of VR Juggler?

I Want to Fix a Bug

I Want to Add New Features

I Want to Add Missing Features

I Think the Current Developers are Overworked

Yes, I Want to Contribute! Where Do I Go From Here?

Rules for Contributions

Submitting Patches to Fix Bugs

Submitting New Features, Implementing Missing Features

Creating and Submitting Patches

Recommended Reading

Making a Patch

Submitting Patches

How to Become a VR Juggler Committer

Why create documentation?

IV. Tutorials

11. Adding ...

V. Appendices

A. Coding Standard

Index