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>This project is based on <a href="http://specialops.ath.cx/b/#mBoard">mBoard 0.2</a>, a slow and poorly designed message board written in about 10 hours.</p>
  16 <p>SO2 is the best free software spinoff board. If you disagree with this, show me a better one and I will outdo it.</p>
  17
  18 <h2>Installation</h2>
  19 <h3>System Requirements</h3>
  20 <p>You need PHP 5.1 and MySQL 5 installed. If something doesn't work, you probably need a PHP extension.</p>
  21
  22 <h3>Setup</h3>
  23 <p>The DB files are in res/. Setup is the same as GFH except for a few things:</p>
  24 <ol>
  25         <li>No board editor. You'll need a separate tool to add them manually.</li>
  26         <li>The admin userlevel doesn't actually give you anything except HTML in posts.</li>
  27         <li>The DB password is set in mysql.php. An example file is in res/.</li>
  28         <li>You need to create css/default.css manually, either by symlink or by making a new file.</li>
  29         <li>If you want to make your account admin anyway or give it invites to start the board with, add rows to the `things` table. Invites need some non-empty text value in the `data` column.</li>
  30 </ol>
  31
  32 <h3>Using the invite system correctly</h3>
  33 <p>The default value in the mysql.example file is to only allow invites by default. Invites can only _prevent_ 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 <p>Also be aware that we will ignore any reported bugs that are a result of broken OSes or incompetent webmasters.</p>
  40
  41
  42 <h2>Developers<!-- Developers Developers Developers Developers Developers Developers Developers Developers--></h2>
  43 <h3>todo list</h3>
  44 <ul>
  45         <li>Admin tools</li>
  46         <li>Need a new HTML parser thing (or three)</li>
  47         <li>Reduce 2 cookie requirement to 1</li>
  48         <li>Fix the "points to next invite" counter</li>
  49         <li>Do something useful with the JS thing</li>
  50 </ul>
  51
  52 <h3>Source</h3>
  53 <p>SVN is at <a href="http://specialops.ath.cx/repos/so2/">http://specialops.ath.cx/repos/so2/</a>.</p>
  54 <p>Release tarballs are at <a href="http://specialops.ath.cx/p/">http://specialops.ath.cx/</a>.</p>
  55 <p>The code is formatted for tab indents, width 4.</p>
  56
  57
  58 <h2>Contributors</h2>
  59 <ul>
  60         <li>Old GFAQs theme by Aquatakat</li>
  61         <li>Various ideas from the IRC/board regulars</li>
  62         <li>No help whatsoever from Jay because he's a fag</li>
  63 </ul>
  64
  65 <div id="footer">
  66         <address>© 2004-2006 Ant P. | <a href="xmpp:ant@specialops.ath.cx">Jabber</a> | <a href="irc://specialops.ath.cx">IRC</a></address>
  67         <p>License: <a href="COPYING" rel="licence">ZLib</a>.</p>
  68 </div>
  69 </body>
  70 </html>