========================================================================
README for Virtual Clay Editing Package
Copyright (c) 2006-2009 Oliver Kreylos
========================================================================

Requirements
============

The Virtual Clay Editing Package requires Vrui version 1.0 build 055 or
newer.

Installation Guide
==================

It is recommended to download or move the source packages for Vrui and
the Virtual Clay Editing Package into a src directory underneath the
user's home directory. Otherwise, references to ~/src in the following
instructions need to be changed.

0. Install Vrui from ~/src/Vrui-1.0 (see Vrui README file).

1. Change into ~/src directory and unpack the Virtual Clay Editing
   Package tarball:
   > cd ~/src
   > tar xfz <download path>/GridEditor.tar.gz
   - or -
   > tar xf <download path>/GridEditor.tar

2. Change into the Virtual Clay Editing Package's base directory:
   > cd GridEditor

3. Adapt makefile if Vrui installation path is *not* ~/Vrui-1.0 by
   setting the VRUIDIR variable to the correct location. VRUIDIR is
   *not* the directory containing Vrui's sources (and the Vrui README
   file), but the directory specified via the INSTALLDIR variable in
   Vrui's makefile.

4. Build the Virtual Clay Editing Package:
   > make
   This creates the GridEditor executable in ./bin.

Running GridEditor
==================

1. On MacOS X: Start X11. GridEditor requires a running X server, but,
   if preferred, it can be started from a MacOS X terminal instead of
   xterm.

2. See Vrui-1.0 documentation on Vrui's basic user interface and how to
   use GridEditor.

3. To manipulate the density field, attach a locator tool to some input
   device button.
