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/default.css"/>
   6 </head>
   7
   8 <body>
   9 <div id="header">
  10         <h1>Special Ops 2 - 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 mBoard, a GameFAQs spinoff I started writing one day to try out SQLite.
  16         I had it working in 7 hours and left it at that. Unfortunately it had one major flaw: people were using it.
  17         Since I never bothered to optimise the SQLite code it ran painfully slow.</p>
  18 <p>The code in mBoard and the other board I had at the time, SO1, was a huge mess. So I rewrote from scratch.</p>
  19 <p>A lot of work has gone into doing things correctly this time, such as testing the code before it's used.
  20         All other spinoffs blindly pile on more and more features without a thought to making them secure.
  21         SQL injection for instance, one of the most common exploits in spinoff boards, is impossible by design in SO2.</p>
  22
  23 <h2>Requirements</h2>
  24 <p>You need PHP 5, MySQL 5 installed. In PHP, make sure the MySQLi, SPL and libxml extensions are enabled.</p>
  25 <p>Also you'll need an operating system with a POSIX-compliant file system such as Solaris, BSD, MacOS X and Linux.
  26         These are freely downloadable from the Internet if you don't already use one for some perverse reason.</p>
  27
  28 <h2>Installation</h2>
  29 <p>The DB files are in res/. Setup is the same as GFH except for a few things:</p>
  30 <ol>
  31         <li>No board editor. You'll have to use phpMyAdmin and add them manually. This may be added in the future.</li>
  32         <li>The admin userlevel doesn't actually do anything right now.</li>
  33         <li>The DB password is in mysql.php. An example file is in res/.</li>
  34 </ol>
  35 <p>You can turn off various features usually by removing code and deleting files.</p>
  36
  37 <h2><del>To Do list</del> <ins>Roadmap</ins></h2>
  38 <ul>
  39         <li>Clean up the messagelist classes (maybe split out the tree/flat view into another 2 classes)</li>
  40 </ul>
  41
  42 <h2>Dev Info</h2>
  43 <p>The latest version of the source is at <a href="http://specialops.ath.cx/repos/so2/">http://specialops.ath.cx/repos/so2/</a>.
  44 This is a Subversion repository, so just do <kbd>svn co http://specialops.ath.cx/repos/so2/trunk/</kbd> to get the latest copy.</p>
  45 <p>The code is formatted for tab indents, width 4. There isn't any formal line length limit.</p>
  46 <p>Bugs, suggestions, fan mail and death threats can be sent to <a href="irc://specialops.ath.cx/">the IRC server</a>.</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 regulars</li>
  52 </ul>
  53
  54 <div id="footer">
  55         <address>© 2004-2005 <a href="irc://specialops.ath.cx/">Ant P.</a></address>
  56         <p>License: <a href="COPYING" rel="licence">ZLib</a>.</p>
  57 </div>
  58 </body>
  59 </html>