$Id$

AUTHORS
------------------------------------------------------------------------------
Tomas Carnecky ([email protected])
Jeremy L. Moles ([email protected])
Michael Ploujnikov ([email protected])


INTRODUCTION
------------------------------------------------------------------------------

Welcome to yukon! If you haven't done so already, please go take a look at:

	http://www.neopsis.com/projects/yukon

This site typically covers all the basics of setup, configuration, and
troubleshooting. However, this document will act as a supplement to that
information.

First and foremost, you MUST have libseom installed! Yukon is now built and
linked against Seom, and will not run otherwise. Second of all, please
realize that Yukon and Seom are still beta applications, and so there
will be bugs. ;)


BUILDING
------------------------------------------------------------------------------

Yukon is a simple 'configure/make' project. Meaning that it can be built and
installed using:

	$ ./configure && make && sudo make install

If you want to cross-compile, set CC on the make command-line.
For example, the following command-line will correctly install the 32bit
version of yukon in a 64bit userspace: 

	$ ./configure --libdir=lib32 && make CC="gcc -m32" && sudo make install


RUNNING
------------------------------------------------------------------------------

Explaining "how" yukon works can be little difficult--therefore, we've
provided a wrapper script written in Bash that you can use to greatly
simplify matters. Just run the "yukon" script (installed into $PREFIX/bin)
with your application and it's parameters following. For example:

	$ yukon glxgears


CONFIGURATION
------------------------------------------------------------------------------

You'll probably want to use the yukon.conf file in the tools directory as
a starting point for you own configuration setups. However, the following
briefly describes which configuration files are parsed when Yukon is invoked.

1. /etc/yukon/conf
2. $HOME/.yukon/conf
3. $HOME/.yukon/programs/$APP
4. $HOME/.yukon/profiles/$PROFILE

$APP is the name of the executable (extracted from /proc/self/cmdline). You
may need to set VERBOSE=4 to see under which name your application is running.
$PROFILE is a profile name as selected using the --profile=??? option of the
yukon script.