Read Me

Welcome to osgNV!

This is a brief introduction to the osgNV library. Remember that this 
is an open-source project, so feel free to modify it and possibly make 
it better. If you fix any bugs, please send me the fixes so I can 
integrate them.

For further information please visit the osgNV website at:
http://osgnv.sourceforge.net.

I would like to thank Robert Osfield and the whole OpenSceneGraph 
community for all the support they provide everyday. If you want to 
know more about the OpenSceneGraph library, go to:
http://www.openscenegraph.org.

See you on the mailing list!

Marco Jez <marco.jez@poste.it>
August 2004




1) INSTALLING THE osgNV LIBRARY
========================================================================

To build the osgNV library. first download the latest cmake building system from:
    
    http://www.cmake.org

Under unices, type the following commands:

    ./configure
    make
    sudo make install

Under Windows, just use the CMake GUI tool to build Visual Studio solutions.




2) DOCUMENTATION
========================================================================

Sources are not well documented, but some comments are already in place.
You can build the documentation with CMake and doxygen (do a 'make DoxygenDoc'
on Unix systems). The documentation files should go into the 'doc' directory.




3) KNOWN ISSUES
========================================================================

- This library is not 100% thread safe. You should be able to use osgNV 
  in multi-pipe systems safely as long as you don't use parameter pickers 
  to update parameter values at run time.

- You may get different results with different graphics driver versions,
  especially when using the nvparse interface. Please UPGRADE YOUR VIDEO 
  DRIVERS TO THE LATEST AND/OR MOST STABLE VERSION.