changed: deal with dxt1 compressed dds volumes
[opensg.git] / Examples / Tutorial / README
blob2ab43f385f823fc53e4a5174524dde2de4937833
1 OpenSG Tutorial
2 ===============
4 The files in this directory are part of the OpenSG tutorial you can find on
5 the project's website (opensg.vrsource.org/trac/wiki/Tutorial).
7 To build the programs you need CMake which you can download from the
8 web (www.cmake.org, you need version 2.6 or later) - for linux there is
9 probably a package for your distribution available.
10 In order to find the OpenSG libraries and some dependencies you need to
11 tell cmake where to find them. Call cmake with the following options:
13  cmake -DOPENSG_ROOT=<PATH_TO_OPENSG>  \
14        -DBOOST_ROOT=<PATH_TO_BOOST>    \
15        -DCOLLADA_ROOT_DIR=<PATH_TO_COLLADA>
17 If you use your system's boost, you don't need the BOOST_ROOT option, it
18 find it, just make sure that it is the same then that used to build
19 OpenSG, or you are likely to run into nasty runtime problems.
20 The COLLADA_ROOT_DIR option can be left out if your OpenSG was not built
21 with collada supprot otherwise it is required.
23 Although the tutorial programs are better commented than the OpenSG code base
24 in general ( ;) ) we still recommend that you follow the online tutorial as it
25 conains information on what aspect of the system is demonstrated and how these
26 relate to each other.
27 The online tutorial is part of our wiki, so if you find typos or would like to
28 improve the explanations there, you are welcome to edit the pages. For
29 questions, ideas or contributions you can contact the opensg-users mailing
30 list opensg-users@lists.sourceforge.net.
32     Enjoy,
33         The OpenSG Team