README.xml

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.0//EN" "http://www.w3.org/TR/2000/REC-xhtml-basic-20001219/xhtml-basic10.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>Requirements</h2>
  19 <p>You need PHP 5.1 and MySQL 5 installed. If something doesn't work, you probably need a PHP extension.</p>
  20 <p>Also if you're using a crippled Microsoft OS, forget it. Your OS won't handle this, and chances are neither can you.</p>
  21
  22 <h2>Installation</h2>
  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 do anything, see above.</li>
  27         <li>The DB password is in mysql.php. An example file is in res/.</li>
  28         <li>You need to create css/default.css manually.</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 a value in the `data` column.</li>
  30 </ol>
  31
  32 <h2>Using the invite system correctly</h2>
  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 <h2>Stuff that needs doing</h2>
  36 <ul>
  37         <li>Admin tools</li>
  38         <li>Need a new HTML parser thing (or three)</li>
  39         <li>Reduce 2 cookie requirement to 1</li>
  40         <li>Fix the "points to next invite" counter</li>
  41 </ul>
  42
  43 <h2>Dev Info</h2>
  44 <p>The latest version of the source is in a Subversion repository at <a href="http://specialops.ath.cx/repos/so2/">http://specialops.ath.cx/repos/so2/</a>. Using this carries the standard disclaimers about using live SVN code.</p>
  45 <p>The code is formatted for tab indents, width 4.</p>
  46 <p>Bug reports can be sent to one of the contact addresses on the SO site or posted on the boards.</p>
  47
  48 <h2>Contributors</h2>
  49 <ul>
  50         <li>Old GFAQs theme by <a href="http://aquatakat.com/">Aquatakat</a></li>
  51         <li>Various ideas from the IRC/board regulars</li>
  52 </ul>
  53
  54 <div id="footer">
  55         <address>© 2004-2006 Ant P. | <a href="xmpp:ant@specialops.ath.cx">Jabber</a> | <a href="irc://specialops.ath.cx">IRC</a></address>
  56         <p>License: <a href="COPYING" rel="licence">ZLib</a>.</p>
  57 </div>
  58 </body>
  59 </html>