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 - Setup Docs</h1>
  11         <p>File last modified: <var>$Id$</var></p>
  12 </div>
  13
  14 <h2>Intro</h2>
  15 <p>SO2 is a GameFAQs spinoff board which has security, moddability and speed. In that respect it's superior to 95% of other spinoffs.</p>
  16
  17 <h2>Installation</h2>
  18 <h3>System Requirements</h3>
  19 <p>You need PHP 5.1 and MySQL 5 installed. If something doesn't work, you probably need a PHP extension.</p>
  20
  21 <h3>Setup</h3>
  22 <p>The DB files are in res/. Setup is the same as GFH except for a few things:</p>
  23 <ol>
  24         <li>No board editor. You'll need a separate tool to add them manually.</li>
  25         <li>The admin userlevel doesn't actually give you anything except HTML in posts.</li>
  26         <li>The DB password is set in <var class="file">mysql.php</var>. An example file is in <var class="file">res/</var>.</li>
  27         <li>You need to create <var class="file">css/default.css</var> manually, either by symlink or by making a new file.</li>
  28         <li>If you want to make your account admin anyway or give it invites to start the board with,
  29                 add rows to the <var class="sql">`things`</var> table. Invites need a UUID() in the <var class="sql">`data`</var> column.</li>
  30 </ol>
  31
  32 <h3>Using the invite system correctly</h3>
  33 <p>The default value in the <var class="file">mysql.example</var> file is to only allow invites by default. Invites can only <em>prevent</em> a shitty userbase, they can't fix an already existing one. Keep that in mind when you switch this off.</p>
  34
  35
  36 <h2>More Help</h2>
  37 <p>If you can't figure out how to get something working,
  38         <a href="http://boards.gamefaqs.com/gfaqs/gentopic.php?board=236">all tech support questions go here</a>.</p>
  39
  40
  41 <h2>Developers<!-- Developers Developers Developers Developers Developers Developers Developers Developers--></h2>
  42 <h3>todo list</h3>
  43 <ul>
  44         <li>Admin tools</li>
  45         <li>Need a new HTML parser thing (or three)</li>
  46         <li>Reduce 2 cookie requirement to 1</li>
  47         <li>Do something useful with the JS thing</li>
  48         <li>Feature parity with other spinoffs</li>
  49 </ul>
  50
  51 <h3>Source</h3>
  52 <p>SVN is at <a href="http://specialops.ath.cx/repos/so2/">http://specialops.ath.cx/repos/so2/</a>.</p>
  53 <p>Release tarballs are at <a href="http://specialops.ath.cx/p/">http://specialops.ath.cx/</a>.</p>
  54 <p>The code is formatted for tab indents, width 4.</p>
  55
  56
  57 <h2>Contributors</h2>
  58 <ul>
  59         <li>Old GFAQs theme by Aquatakat</li>
  60         <li>Various ideas from the IRC/board regulars</li>
  61         <li>No help whatsoever from Jay because he's a fag</li>
  62 </ul>
  63
  64 <div id="footer">
  65         <address>© 2004-2006 Ant P. | <a href="xmpp:ant@specialops.ath.cx">Jabber</a> | <a href="irc://specialops.ath.cx">IRC</a></address>
  66         <p>License: <a href="COPYING" rel="licence">ZLib</a>.</p>
  67 </div>
  68 </body>
  69 </html>