Last updated: 31 March 2004 Contact us: 60hz@csse.uwa.edu.au
Real-time Rendering Group Department of Computer Science and Software Engineering, The University of Western Australia	"If you can't do it in realtime, it's not worth doing"
These instructions are now obsolete and are provided for archival purposes only

Clean is mostly self contained and depends upon few other libraries. It obviously depends on OpenGL, GLU and GLUT which should be pre-installed on most machines in the department. It also depends upon libjpeg and libpng for texture loading, these libraries are probably already installed on your machine. If at any stage you have any problems, send mail to 60hz@csse.uwa.edu.au.

First of all, it is necessary to be part of the 60hz unix group to have access to the files on the CVS server. Use the linux command groups to determine the groups you are part of. Hopefully you are already in 60hz, otherwise, contact 60hz@csse.uwa.edu.au.

The command line for accessing a remote CVS server is fairly long, so it helps to have an alias setup in your ~/.zshrc (or similar) file. The line below works well and can be added to the bottom of ~/.zshrc. Obviously change username to your own CSSE username.

alias 60hzcvs='cvs -d :ext:username@projects.csse.uwa.edu.au:/home/projects/misc/60hz/cvsroot'

The CVS_RSH environment variable governs what type of shell is used to access the cvs server. This should be set to ssh instead of the default rsh with the following line, also in your ~/.zshrc.

export CVS_RSH="ssh"

Exit and restart the terminal to make sure the changes to ~/.zshrc take effect.

Now you should be able to use the alias created above to checkout the code. Move into your root directory and try this:

60hzcvs checkout clean2

Now you should have a clean2/ directory in you home directory.

Before compiling we should setup the LD_LIBRARY_PATH environment variable. This basically tells the gcc linker "ld" where to else to find libraries other than /usr/lib/. Add this line to the ~/.zshrc. It adds ~/lib to the list of directories gcc will search.

export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:$HOME/lib/

Once again exit and restart the terminal to make sure the changes to ~/.zshrc take effect.

Now you can compile. There are a few ways to do this, most are explained in the README file in the clean2/ directory. The recommended way is to go into the clean2/ directory and do the following:

make install_home

This should add a include/ and lib/ directories to your home directory. The include/ dir should contain a few header files for cl, clu and clio. The lib/ dir should contain a few dynamic libraries for cl, clu, clio (should have names like libCL.so etc)

To see if the install worked, you can try to compile some demos for cl, clu and clio. For example, in clean2/cl/demo, do the following:

make

It should compile an executable called cube. Try running it.

Gian's CVS Howto