File	Date	Author	Commit
cmake	2012-10-01	Stavros Delisavas	[d5c99b] Merge remote-tracking branch 'origin/independen...
contrib	2012-06-21	Stefan Zellmann	[8cf41e] Add DISPLAY variable to init.d script
virvo	2012-11-28	Stefan Zellmann	[cade70] Merge branch 'master' of ssh://deskvox.git.sour...
vox-desk	2012-09-27	Stefan Zellmann	[918f67] vox-desk: changes in gamma dialog have an effect
.envrc	2011-10-20	aumuell	[c243bc] replace occurences of vview
.gitignore	2011-11-08	charmaman	[61223a] move ignore-entry into corresponding subdir
AUTHORS.txt	2012-01-30	aumuell	[a4e687] add tbs- to authors
CMakeLists.txt	2012-10-01	Stavros Delisavas	[d5c99b] Merge remote-tracking branch 'origin/independen...
README.txt	2011-10-17	aumuell	[c8ee2f] update

Read Me

Welcome to DeskVOX Volume Explorer (DeskVOX)

0. Content
==========

 1. How to obtain DeskVOX
 2. Additional dependencies
 3. How to build DeskVOX and vconv from source
 4. How to build the Virvo library from source

***

1. How to obtain DeskVOX
========================

Download a zip archive from [Sourceforge] (http://sourceforge.net/projects/deskvox)
or check out DeskVOX via Subversion:

    $ svn co https://deskvox.svn.sourceforge.net/svnroot/deskvox/trunk deskvox


2. Additional dependencies
==========================

The Virvo library won't build without the following libraries installed

- Pthreads: POSIX Threads Library
- GLEW: The [OpenGL Extension Wrangler Library]
  (http://glew.sourceforge.net)

The DeskVOX applicaton won't build without the following libraries installed

- [FOX TOOLKIT 1.6] (http://www.fox-toolkit.org): GUI

Having the following libraries installed is recommended but not necessary:

- [Cg Toolkit] (http://developer.nvidia.com/cg-toolkit) (NVIDIA COORP)
- [CUDA Toolkit] (http://developer.nvidia.com/category/zone/cuda-zone) (NVIDIA COORP)
- [FFmpeg] (http://ffmpeg.org/): video codecs
- [snappy] (http://code.google.com/p/snappy/): fast compression
- [NORM] (http://cs.itd.nrl.navy.mil/work/norm/): reliable multicast

Not all features will be available without these libraries.


3. How to build DeskVOX and vconv from source
=============================================

DeskVOX uses the [CMake] (http://www.cmake.org/) build system to generate a
project specific to your platform to be built from. Obtain CMake from
[http://www.cmake.org] (http://www.cmake.org/) or by means
provided by your operating system.

Switch to the topmost folder of the DeskVOX package you downloaded or the
topmost folder of the branch you wish to build if you checked out DeskVOX via
Subversion (i.e. the folder this document is located in).

CMake encourages you to do so called out-of-source builds, i.e. all files, e.g.
object files, executables or auto-generated headers will be located in a folder
separate from the folder the source files are located in.

In order to perform an out-of-source build, create a new build directory, e.g.:

    $ mkdir build

Change to that directory:

    $ cd build

Invoke CMake:

    $ cmake ..

This will generate a project files suitable for your platform, e.g. Visual
Studio Solutions on Windows or a Makefile project on Unix.
Edit CMakeCache.txt to specify custom paths to additional libraries, perform
a Debug build, etc. Alternatively, use 'ccmake' or a CMake GUI instead
of 'cmake'.

After CMake has generated the build files for your build system, proceed
as required.

On Unix platforms, type:

    $ make

After this step, the DeskVOX application will be located in
build/vox-desk/src,
the static Virvo library in build/virvo/virvo,
the vview test application in build/virvo/tools/vview
and the vconv conversion tool in build/virvo/tools/vconv.

In order to install DeskVOX and its associated files type:

    $ make install

DeskVOX will be installed to a default location, which can be modified
before installing by editing CMakeCache.txt in build.

On Windows, use the generated solution files for Microsoft Visual Studio
and build the corresponding targets in the IDE.


4. How to build the Virvo library from source
=============================================

In order to build only the Virvo library, switch to the virvo folder right
under the topmost folder of the one this document is located in. As
described under 3., create a build folder for an out-of-source build, e.g.:

    $ mkdir build

Change to that directory:

    $ cd build

Invoke CMake:

    $ cmake ..

Optionally edit CMakeCache.txt (for a more detailled description, see 3.).

On Unix platforms, type:

    $ make

The Virvo library will be located in build/virvo.