Permalink
Browse files

Update README, use markdown so it renders nicely on github

  • Loading branch information...
1 parent c9ba909 commit 988a00243f80b3674da34c6dc13ad51a3022240c @wereHamster committed Mar 18, 2012
Showing with 66 additions and 68 deletions.
  1. +0 −68 README
  2. +66 −0 README.md
View
@@ -1,68 +0,0 @@
-$Id$
-
-AUTHORS
-------------------------------------------------------------------------------
-Tomas Carnecky (tom@dbservice.com)
-Jeremy L. Moles (jeremy@emperorlinux.com)
-Michael Ploujnikov (ploujj@gmail.com)
-
-
-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.
View
@@ -0,0 +1,66 @@
+
+Introduction
+------------
+
+Yukon is a set of libraries and applications that are designed to capture
+realtime videos of OpenGL applications (games).
+
+
+
+Building
+--------
+
+Yukon depends on [seom][seom], and a few standard X11/OpenGL libraries. Other
+than that, it's a standard configure+make project.
+
+ ./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.
+
+ - /etc/yukon/conf
+ - $HOME/.yukon/conf
+ - $HOME/.yukon/programs/$APP
+ - $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.
+
+
+
+Authors
+-------
+
+ - Tomas Carnecky (tomas.carnecky@gmail.com)
+ - Jeremy L. Moles (jeremy@emperorlinux.com)
+ - Michael Ploujnikov (ploujj@gmail.com)
+
+
+
+[seom]: https://github.com/wereHamster/seom

0 comments on commit 988a002

Please sign in to comment.