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/default"/>
   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. I had it working in 7 hours and got bored with it. Then people started using it and it ran too slow.</p>
  16 <p>The code in mBoard and SO1 was a huge mess. So I rewrote it almost completely from scratch.</p>
  17 <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>
  18
  19 <h2>Requirements</h2>
  20 <p>You need PHP 5.1 and MySQL 5 installed. If something doesn't work, you probably need a PHP extension.</p>
  21 <p>Also due to a limitation in the mental capacity of Microsoft developers, some files will not work on Windows. I have no intention or motivation to fix this.</p>
  22
  23 <h2>Installation</h2>
  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. You'll need a separate tool to add them manually.</li>
  27         <li>The admin userlevel doesn't actually do anything, see above.</li>
  28         <li>The DB password is in mysql.php. An example file is in res/.</li>
  29         <li>You need to create css/default.css manually.</li>
  30 </ol>
  31
  32 <h2>Known bugs</h2>
  33 <ul>
  34         <li>Deleting a user deletes any topics they've posted in, not just made (probably a foreign key problem)</li>
  35         <li>Need a new HTML parser thing</li>
  36 </ul>
  37
  38 <h2>Dev Info</h2>
  39 <p>The latest version of the source is in a Subversion repository at <a href="//specialops.ath.cx/repos/so2/">http://specialops.ath.cx/repos/so2/</a>. A lot of the time this won't work properly.</p>
  40 <p>The code is formatted for tab indents, width 4.</p>
  41 <p>Bug reports can be sent to one of the contact addresses on the SO site or posted on the boards.</p>
  42
  43 <h2>Contributors</h2>
  44 <ul>
  45         <li>Old GFAQs theme by <a href="//aquatakat.com/">Aquatakat</a></li>
  46         <li>Various ideas from the IRC regulars</li>
  47 </ul>
  48
  49 <div id="footer">
  50         <address>© 2004-2005 <a href="xmpp:ant@specialops.ath.cx">Ant P.</a></address>
  51         <p>License: <a href="COPYING" rel="licence">ZLib</a>.</p>
  52 </div>
  53 </body>
  54 </html>