Changes between Version 100 and Version 101 of BuildInstructions

Timestamp:

Oct 3, 2010, 11:36:02 PM (14 years ago)

Author:

Philip Taylor

Comment:

improve formatting

BuildInstructions

@@ -77 +77 @@
    * CMake
    * ''Optionally'': [http://code.google.com/p/nvidia-texture-tools NVTT] (pass the flag `--with-system-nvtt` to `update-workspaces.sh` to use the installed version; otherwise we'll automatically use a bundled copy of the library)
-
- * For '''Ubuntu''' or '''Debian''' (at least unstable and testing) the following might help:
+   * For '''Ubuntu''' or '''Debian''' (at least unstable and testing) the following might help:
  {{{
 #!html
@@ -85 +84 @@
 </pre>
 }}}
-
- * For '''Mandriva''' (tested with 2009.1):
- {{{
+   * For '''Mandriva''' (tested with 2009.1):
+     {{{
 #!html
 <pre class="wiki" style="white-space: pre-wrap">
@@ -93 +91 @@
 </pre>
 }}}
- No ENet package is available, so [http://enet.bespin.org/Installation.html install it from source].
-
- * For '''Fedora''' (tested with 13):
+     No ENet package is available, so [http://enet.bespin.org/Installation.html install it from source].
+   * For '''Fedora''' (tested with 13):
  {{{
 #!html
@@ -103 +100 @@
 }}}
 
- * `svn co http://svn.wildfiregames.com/public/ps/trunk/`
- * `cd trunk/build/workspaces`
- * `./update-workspaces.sh` (if you update to a later version of the code from SVN, you should run this again each time)
- * `cd gcc`
- * `make CONFIG=Release -j3` (where `3` is the number of parallel builds to run, and could perhaps be one plus the number of CPU cores available)
-   * '''Note''': Parallel building can cause errors due to race conditions. Run a "make clean" and try just "make" if you encounter problems.
-   * The Release mode builds are more optimised, are harder to debug. Use `CONFIG=Debug` (and run `pyrogenesis_dbg`) if you are developing engine code that needs debugging.
+ * Download and compile the code with:
+ {{{
+svn co http://svn.wildfiregames.com/public/ps/trunk/
+cd trunk/build/workspaces
+./update-workspaces.sh
+cd gcc
+make CONFIG=Release -j3
+}}}
+ "`-j3`" gives the number of parallel builds to run, and should typically be one plus the number of CPU cores available.
+ * The Release mode builds are more optimised, are harder to debug. Use `CONFIG=Debug` (and run `pyrogenesis_dbg`) if you need better debugging support.
  * If you encounter any build errors, look for an existing bug report or report a new bug. Also check the [#Knownproblemsandsolutions known problems section] below.
- * `cd ../../../binaries/system`
- * Optionally, run the automated tests to verify that everything works as expected: `./test`
- * Run the game: `./pyrogenesis`
- * Optionally, run the map editor: `./pyrogenesis -editor`
+ * Run the automated tests to verify that everything works as expected, then run the game:
+ {{{
+cd ../../../binaries/system
+./test
+./pyrogenesis
+}}}
+
+ * If you have already compiled the game from SVN and want to update to the latest version:
+ {{{
+cd trunk
+svn up
+cd build/workspaces
+./update-workspaces.sh
+cd gcc
+make CONFIG=Release clean
+make CONFIG=Release -j3
+}}}
 
 === OS X ===