* Instructions page near-done

git-svn-id: svn://svn.icculus.org/quake3/trunk@255 edf5b092-35ff-0310-97b2-ce42778d08ea

1 files changed, 41 insertions, 13 deletions

diff --git a/web/include/instruc.php b/web/include/instruc.php
index 68361db..409009d 100644
--- a/web/include/instruc.php
+++ b/web/include/instruc.php
@@ -1,4 +1,6 @@
 <h2>Check out and build from Subversion</h2>
+<p>(This part assumes Windows users are using Cygwin. If you aren't,
+<a href="http://tortoisesvn.tigris.org/">TortoiseSVN</a> is a good client.)</p>
 <ol>
 	<li>Change into a directory that you want the tree to be kept in.</li>
 	<li>Check out the source tree:<br />
@@ -8,29 +10,55 @@
 	<span class="shell">svn co svn://svn.icculus.org/quake3/trunk quake3 -r100</span>)
 	</li>
 	<li>Read the <a href="http://svn.icculus.org/*checkout*/quake3/trunk/i_o-q3-readme">readme</a> file. Really. Do it.</li>
-	<li>Compile and install Quake III.
+	<li>Compile and install Quake 3:
 		<ul>
 			<li><h3>Linux and friends</h3>
 				<ol>
+					<li>Install Quake 3 for Linux using the latest point release
+					installer. While the Quake3 engine is Free Software, you
+					still need to copy over legal PK3s like before.</li>
 					<li>Change into the top level directory (it contains the
 					<span class="shell">ui</span> and <span class="shell">code</span>
 					directories.)</li>
-					<li>Run <span class="shell">make</span></li>
-					<li>Create a directory to install Quake3 into:<br />
-					<span class="shell">mkdir /usr/local/games/quake3</span></li>
-					<li>Copy 
-					
+					<li>Run <span class="shell">make</span>.</li>
+					<li>Set <span class="shell">$COPYDIR</span> to the directory
+					you installed Quake3 to	and make the copyfiles target.
+					Make sure you are changed to the owner of this path (probably
+					root).<br />
+					<span class="shell">COPYDIR="/opt/quake3" make copyfiles</span></li>
 				</ol>
 			</li>
 			<li><h3>Windows</h3>
-				<ol>
-					<li></li>
-				</ol>
+				<p>Building on Windows is slightly complicated. You can either
+				use Microsoft Visual C++ or MinGW. MinGW works better currently;
+				both methods are described in the
+				<a href="http://svn.icculus.org/*checkout*/quake3/trunk/i_o-q3-readme">readme</a>
+				you already are supposed to have read.</p>
 			</li>
 		</ul>
 	</li>
+	<li>If everything has gone well, you should have a binary that works! If not, seek <a href="#">help</a>.</li>
 </ol>
-<h2>How to submit your changes:</h2>
-<p>rules rules rules, angry zakk-style text rules rules rules, angry zakk-style text rules rules rules, angry zakk-style text rules rules rules, angry zakk-style text rules rules rules, angry zakk-style text rules rules rules, angry zakk-style textrules rules rules, angry zakk-style text</p>
-<p>rules rules rules, angry zakk-style textrules rules rules, angry zakk-style text rules rules rules, angry zakk-style textrules rules rules, angry zakk-style textrules rules rules, angry zakk-style text rules rules rules, angry zakk-style textrules rules rules, angry zakk-style textrules rules rules, angry zakk-style text rules rules rules, angry zakk-style textrules rules rules, angry zakk-style text</p>
-<p>rules rules rules, angry zakk-style textrules rules rules, angry zakk-style text rules rules rules, angry zakk-style textrules rules rules, angry zakk-style textrules rules rules, angry zakk-style text rules rules rules, angry zakk-style textrules rules rules, angry zakk-style textrules rules rules, angry zakk-style text rules rules rules, angry zakk-style textrules rules rules, angry zakk-style textrules rules rules, angry zakk-style text rules rules rules, angry zakk-style textrules rules rules, angry zakk-style text</p>
+<h2>Pay your dues, contribute!</h2>
+<p>If you've come up with an improvement or fixed something, we'd love to hear about it!
+Firstly, <em>try</em> to make sure that the patch breaks less than it fixes. We don't
+require everyone to be decorated Geniuses, but do attempt to produce a patch that you've
+tested and at list sort-of understand what you're doing.</p>
+<p>Not everyone who knows C knows how to use <span class="shell">diff</span> (the tool
+you need to create patches with), and not everyone is making patches against the C code.
+That's okay, here's the 10¢ survival guide to making patches:</p>
+<ul>
+	<li>Create a patch between <em class="shell">oldfile</em> and <em class="shell">newfile</em>:<br />
+	<span class="shell">diff -u <em>oldfile</em> <em>newfile</em></span></li>
+	<li>Create a patch between directory <em class="shell">olddir</em> and <em class="shell">newdir</em>:<br />
+	<span class="shell">diff -Naur <em>olddir</em> <em>newdir</em></li>
+	<li>Apply a patch <em class="shell">amazing_new_feature.patch</em>:<br />
+	<span class="shell">patch -p0 -i <em>amazing_new_feature.patch</em></span></li>
+</ul>
+<p>For more information on <span class="shell">diff</span> and <span class="shell">patch</span>,
+read their man-pages.</p>
+<p>The prefered way to get the ball rolling on a patch is to file a <a href="http://bugs.icculus.org">bug</a>
+for your patch and attach the patch to it and then send a notice to the mailing list
+about it. If you're really so lazy that you can't do this, we would prefer you at least
+<a href="mailto:zakk@icculus.org">mail it to zakk@icculus.org</a> rather than not do
+anything.</p>