README.xml

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-GB">
   3 <head>
   4 <title>SO2 Readme</title>
   5 <link rel="stylesheet" type="text/css" href="css/fm.css"/>
   6 </head>
   7
   8 <body>
   9 <div id="header">
  10         <h1>Special Ops 2 Documentation</h1>
  11         <p>File last modified: <var>$Id$</var></p>
  12 </div>
  13
  14 <h2>Intro</h2>
  15 <p>SO2 is yet another message board based on the GameFAQs boards. It also borrows a few ideas from Slashdot.</p>
  16 <p>The design goal was to make something easy to work with and customise, instead of just another clone of GameFAQs. This never was, and never will be intended as a one-size-fits-all solution like Mediarchive or whiteFyre. Look at all the dead/bloated/exploit-filled/slow/buggy sites based on or modelled after those to see why. And yes I'm singling out OB there.</p>
  17 <p>SO2's earned a good reuptation on the GF boards for having clean, readable code, so it's useful to look at if you're learning PHP. In any case it's a better choice than the competition.</p>
  18
  19 <h2>Installation</h2>
  20 <h3>System Requirements</h3>
  21 <p>You need PHP 5.1 and MySQL 5 installed. If something doesn't work, you probably need a PHP extension. Having a decent OS also helps.</p>
  22
  23 <h3>Setup</h3>
  24 <p>The DB files are in res/. Setup is the same as GFH except for a few things:</p>
  25 <ol>
  26         <li>No board editor. Use phpMyAdmin, the table columns are self-descriptive anyway.</li>
  27         <li>The admin userlevel doesn't actually give you anything except HTML in posts.</li>
  28         <li>The DB password is set in <var class="file">mysql.php</var>. An example file is in <var class="file">res/mysql.example</var>.</li>
  29         <li>You need to create <var class="file">css/default.css</var> manually, either by symlink or by making a new file.</li>
  30         <li>If you want to make your account admin anyway or give it invites to start the board with, add stuff to the <var class="sql">`things`</var> table. Invites need some value in the <var class="sql">`data`</var> column for authentication; read <var class="file">register.php</var> for more info.</li>
  31 </ol>
  32
  33
  34 <h2>More Help</h2>
  35 <p>If you can't figure out how to get something working, <a href="http://boards.gamefaqs.com/gfaqs/gentopic.php?board=236">ask WDP first</a>. Being mostly spinoff users themselves, they'll be more than happy to answer any SO2-related questions you may have.</p>
  36
  37
  38 <h2>Developers<!-- Developers Developers Developers Developers Developers Developers Developers Developers--></h2>
  39 <h3>todo list</h3>
  40 <ul>
  41         <li>Admin tools</li>
  42         <li>Need a new HTML parser thing (or three)</li>
  43 </ul>
  44
  45 <h3>Source</h3>
  46 <p>SVN is at specialops.ath.cx/repos/so2/ and is usually the most up-to-date code. If you don't know what this is, don't use it.</p>
  47 <p>Release tarballs are at <a href="http://specialops.ath.cx/p/">http://specialops.ath.cx/</a>.</p>
  48 <p>The code is formatted for tab indents, width 4.</p>
  49
  50
  51 <h2>Contributors</h2>
  52 <ul>
  53         <li>Old GFAQs theme by Aquatakat</li>
  54         <li>Various ideas from the IRC/board regulars</li>
  55         <li>No help whatsoever from Jay because he's a fag</li>
  56 </ul>
  57
  58 <div id="footer">
  59         <address>© 2004-2006 Ant P. | <a href="xmpp:ant@specialops.ath.cx">Jabber</a> | <a href="irc://specialops.ath.cx">IRC</a></address>
  60         <p>License: <a href="COPYING" rel="licence">BSD</a>.</p>
  61 </div>
  62 </body>
  63 </html>