Revision: 6845
http://playerstage.svn.sourceforge.net/playerstage/?rev=6845&view=rev
Author: jeremy_asher
Date: 2008-07-11 11:09:45 -0700 (Fri, 11 Jul 2008)
Log Message:
-----------
Fixed INSTALL formatting
Modified Paths:
--------------
code/stage/trunk/INSTALL
Modified: code/stage/trunk/INSTALL
===================================================================
--- code/stage/trunk/INSTALL 2008-07-11 08:34:42 UTC (rev 6844)
+++ code/stage/trunk/INSTALL 2008-07-11 18:09:45 UTC (rev 6845)
@@ -1,7 +1,10 @@
Build system
------------
-Stage is now built using the CMake build system (version 2.4.7 or newer).
This has two main advantages: (i) it is much faster; (ii) CMake can create
native build files for Windows and Mac OS X, which will help Stage become more
portable.
+Stage is now built using the CMake build system (version 2.4.7 or newer).
+This has two main advantages: (i) it is much faster; (ii) CMake can
+create native build files for Windows and Mac OS X, which will help
+Stage become more portable.
Configuring the build
@@ -11,7 +14,7 @@
First, you may need to help CMake find your the libraries on which
Stage depends. For example, if you use MacPorts on OS X, packages are
-usually installed in /opt/local, which is not in CMake's default
+usually installed in `/opt/local`, which is not in CMake's default
system search path. Add your non-standard software directories to
CMake's search paths by setting environment variables, e.g. in bash:
@@ -25,33 +28,36 @@
This should output the version number of the Player installation
(probably 2.2.0 or later). If not, add the location of Player's
-pkg-config file to your PKG_CONFIG_PATH, eg. in bash:
+pkg-config file to your `PKG_CONFIG_PATH`, eg. in bash:
$ export PKG_CONFIG_PATH+=<Player installation prefix>/lib/pkgconfig
Now that the supporting software is set up, you can decide where you
want to install Stage. The default installation directory varies by
-system, but is often /usr/local on Unix variants. This is easy and is
+system, but is often `/usr/local` on Unix variants. This is easy and is
often a good choice, but has the disadvantage that installation needs
root/sudo priviliges. To install in the default location, do:
$ cmake .
-If you wish to install Stage elsewhere, define the CMAKE_INSTALL_PATH
+If you wish to install Stage elsewhere, define the `CMAKE_INSTALL_PATH`
path variable when invoking cmake. To do this, use this command,
-substituting <prefix> with your chosen installation
+substituting `<prefix>` with your chosen installation
directory.
$ cmake -DCMAKE_INSTALL_PREFIX=<prefix> .
-For example to install in $HOME/playerstage, do:
+For example to install in `$HOME/playerstage`, do:
$ cmake -DCMAKE_INSTALL_PREFIX=$HOME/playerstage .
Cmake will generate makefiles specifically for your machine. When this
-is done, you can inspect and edit the build settings using ccmake, or
-by editing the file CMakeCache.txt.
+is done, you can inspect and edit the build settings by using ccmake:
+ $ ccmake .
+
+or by editing the file CMakeCache.txt manually.
+
Building
--------
In the top level directory of the source tree, do:
@@ -69,9 +75,9 @@
Stage will install its components in various directories, for example:
-<prefix>/bin (executables, including the 'stage' program)
-<prefix>/lib (libraries, including libstage)
-<prefix>/share (contains data resources, such as images)
+ <prefix>/bin (executables, including the 'stage' program)
+ <prefix>/lib (libraries, including libstage)
+ <prefix>/share (contains data resources, such as images)
Setup
-----
@@ -80,27 +86,27 @@
found by your system's library loader. The method for doing this
varies by platform.
-On Linux, using BASH:
+On Linux, using bash:
$ export LD_LIBRARY_PATH=<prefix>/lib
-On OS X, using BASH:
+On OS X, using bash:
$ export DYLD_LIBRARY_PATH=<prefix>/lib
-If you plan to use Stage plugins, you also need to set the STAGEPATH
+If you plan to use Stage plugins, you also need to set the `STAGEPATH`
environment variable to include the directory that contains your
-plugins. E.g. in BASH, do:
+plugins. E.g. in bash, do:
$ export STAGEPATH=/usr/local/lib
-If you installed Stage somewhere other than /usr/local, substitute
+If you installed Stage somewhere other than `/usr/local`, substitute
your install prefix:
$ export STAGEPATH=<stage install prefix>/lib
If you are using Stage with Player, you probably don't need to set the
-STAGEPATH. However, you may need to set the PLAYERPATH to include
+`STAGEPATH`. However, you may need to set the `PLAYERPATH` to include
Stage's installed lib directory instead.
Testing
@@ -135,8 +141,5 @@
Enjoy using Stage -- rtv
-"All the world's a stage, and all the women merely players"
+"All the world's a stage, and all the men and women merely players"
Wm. Shakespeare - "As you like it"
-
-Stage v.3 build using CMake instructions
-Author: Richard Vaughan, 2008.4.11 $Id$
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
Sponsored by: SourceForge.net Community Choice Awards: VOTE NOW!
Studies have shown that voting for your favorite open source project,
along with a healthy diet, reduces your potential for chronic lameness
and boredom. Vote Now at http://www.sourceforge.net/community/cca08
_______________________________________________
Playerstage-commit mailing list
Playerstage-commit@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/playerstage-commit
