peterc / mrsusan

MrSusan - Flexible Ruby-powered Wiki
Created by Peter Cooper

WHAT
  * Ruby wiki implemented in Sinatra
  * Implemented primarily for use on http://rubypedia.com/ but it's flexible.
  
CURRENT STATUS
  [2009-05-18]
    * TOTALLY INCOMPLETE AND ONLY MODELS WORK. DO NOT USE PUBLICLY!
  
SPECS (A.K.A. TESTING)
  * Full specs throughout
  * Run specs with:
    # rake spec
      
DEPENDENCIES
  * Install these gems (one from Gemcutter):
      sinatra sequel validatable sqlite3-ruby WikiCreole peterc-sanitize syntax

  * And optionally (to use caching or run specs):
      memcache-client rack-test rspec
      
INSTALLATION
  * Tweak the configuration file in mrsusan/mrsusan.yaml
  
  * Run specs / tests with:
    # rake spec
  
  * Start her up for a quick spin with:
    # thin --rackup config.ru start
    (Initial admin password given at this point, so keep your eyes peeled!)
  
  * Deploy using favorite Rack deployment method (e.g. Phusion Passenger)
  
NOTES
  * The formatting system is /based/ around Creole: http://www.wikicreole.org/
  
LICENSE
  * Please refer to the LICENSE file. If it is missing, assume the MIT License.
  
FURTHER RESOURCES
  * Want to learn about building a wiki generally?
      http://www.usemod.com/cgi-bin/mb.pl?WikiLifeCycle