root/OpenSceneGraph-TrainingMaterials/trunk/Sources/README.txt

Revision 8061 (checked in by robert, 9 months ago)

Updated README to include a section of intended purpose, cleaned up env vars

Line 
1 Sources
2 =======
3
4 This directory contains all the source code related to
5 the training materials, both the externals projects
6 and the Exercises are included and are inteded to
7 compiled by you as you work through the training.
8
9
10 External projects included are
11 ------------------------------
12
13     OpenSceneGraph - scene graph library
14    
15     VirtualPlanetBuilder - large scale terrain builder
16    
17     Present3D - 3D presentation tool
18
19    
20 Training course work
21 --------------------
22
23     Execerices - a collection of applications that
24                  the user review and modify during
25                  the course.
26    
27     Resources - a collection of useful files and
28                 resources that can help you set up
29                 build and executation of applications
30                
31
32 Setting up include, lib and binary paths
33 ----------------------------------------
34                
35 For the purposes of this course it is recommend that rather
36 than install lib and binaries, the developer just sets up environmental
37 variable to point to respective ProjectName/include, Project/lib and
38 Project/bin directories. To make the task of setting these paths up
39 there is an Sources/Resouces/training.rc file which under unices can be
40 included in your .bashrc/.tcshrc file by adding the following:
41
42 To ~/.bashrc
43
44    export COURSE_DIR=~/OpenSceneGraph-TrainingMaterials
45    source ${COURSE_DIR}/Sources/Resources/env_vars.bash
46
47 To ~/.tshrc
48
49    setenv COURSE_DIR ~/OpenSceneGraph-TrainingMaterials
50    source ${COURSE_DIR}/Sources/Resources/env_vars.tshrc
51
52 Then logout/login or just start a new shell to get the new variables.
53
54 Building sources
55 ----------------                   
56
57 CMake is used by all projects to create platform specific
58 makefiles/project files.  Under unices, once you have set
59 up the env vars discussed above, simply uses:
60
61   cd ProjectName
62   ./configure
63   make -j <num_of_cores>
64
65 Or use the build_all.sh script that provided for unix users, so one
66 can simply run:
67
68   ./build_all.sh
69  
70
Note: See TracBrowser for help on using the browser.