README.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2
   3 <!-- Just to piss all you WDP validation fundies off I'm using HTML 5. Validate this, bitch. -->
   4 <html xmlns="http://www.w3.org/1999/xhtml">
   5 <head>
   6 <title>SO2 Readme</title>
   7 <link rel="stylesheet" type="text/css" href="css/default.css"/>
   8 </head>
   9
  10 <body>
  11 <header>
  12         <h1>Special Ops 2 Documentation</h1>
  13         <p>Last modification: $Id$</p>
  14 </header>
  15
  16 <h2>Intro</h2>
  17 <section>
  18 <p>This project is based on mBoard, a GameFAQs spinoff I started writing one day to try out SQLite.
  19         I had it working in 7 hours and left it at that. Over time it gained users in the <!-- BRIDGE OUT --></p>
  20 <p>The code in mBoard as well as SO1.x was a pile of cack, so I threw it all out and rewrote it from scratch.</p>
  21 <p>With this being my third attempt at writing a message board, the design is a lot better thought-out.</p>
  22
  23 <!-- How's THIS for semantics abuse? -->
  24 <aside>And unlike most of the crap these days, this spinoff got somewhere. I'm looking at you, WebFAQs.</aside>
  25 </section>
  26
  27 <h2>Requirements</h2>
  28 <section>
  29 <p>You need PHP 5 and MySQL 5. And the PHP extensions mysqli and SPL.
  30         And an operating system that isn't criminally brain-damaged.</p>
  31 </section>
  32
  33 <h2>Installation</h2>
  34 <section>
  35 <p>The DB files are in res/.</p>
  36 <p>Setup is virtually the same as GFH, except there's no board editor yet.</p>
  37 </section>
  38
  39 <h2>To Do list (major)</h2>
  40 <section>
  41 <dl>
  42 <dt>Moderation system</dt>
  43 <dd>Most of the work needed for this is in SVN already.
  44         <del>Doing this cleanly will probably need rewriting the messagelist classes to take result sets as params.</del> (done all that)</dd>
  45 <dt>New user privs system</dt>
  46 <dd>Some sort of simplified ACL/Access Level combination should fit better than the horrible mess other sites call "user levels".</dd>
  47 </dl>
  48 </section>
  49
  50 <h2>Dev info</h2>
  51 <section>
  52 <p>The latest public version of the source is at
  53 <a href="http://specialops.ath.cx/repos/so2/trunk/">http://specialops.ath.cx/repos/so2/trunk/</a>.
  54 This is a Subversion repository, so you can checkout the source and poke around using whatever SVN client you prefer.
  55 Of course there's nothing stopping people from wasting hours of their own time downloading it a file at a time using a browser,
  56    other than common sense.</p>
  57 <p>The code is formatted for tab indents, width 4. It's also formatted to look readable. Keep it that way.</p>
  58 <p>Bugs, suggestions, fan mail and death threats can be sent to <a href="irc://specialops.ath.cx/whitefyre">the IRC server</a>.
  59         Register a username if you want to get in, as it's <code>chmode +R</code> on most days. WDPers can go fuck themselves.</p>
  60 </section>
  61
  62 <footer id="footer">
  63         <address>© 2004-2005 <a href="irc://specialops.ath.cx/">Ant P.</a></address>
  64         <p rel="licence">License: <a href="COPYING">ZLib</a>.</p>
  65 </footer>
  66 </body>
  67 </html>