What is it?
===========

LesserWiki is the TiddlyWiki style Wiki engine using Ajax.
LesserWiki is a Rails application.

Requirements
============

Currently you need all of those things to get LesserWiki to run:

 * Rails (Most likely the latest version)
 * Redcloth
 * MySQL or PostgreSQL

The following browsers can be used. 

 * Internet Explorer 6.0 or later
 * Firefox 1.0 or later
 * Safari 2.0 or later

(Opera cannot save a tiddler.)

Installation
============

If you have not installed Rails, you have to install it first.

 * Download RubyGems from http://rubyforge.org/frs/?group_id=126
   and follow the setup instructions of it.
 * Execute "gem install rails"

If you have not installed RedCloth, you have to install it as follows.

  % gem install redcloth

Unpack the zip in some directory.

You have to choose whether to use MySQL, PostgreSQL or SQLite.
Both are supported. SQLite might work (but we have not test it yet).

If you choose MySQL, Ruby's mysql library is required.
You can install it as follows.

  % gem install mysql

If you choose PostgreSQL, Ruby's postgres library is required.
You can install it as follows.

  % gem install postgres

If you choose SQLite2, sqlite-ruby is required.
You can install it as follows.

  % gem install sqlite

If you choose SQLite3, sqlite3-ruby is required.
You can install it as follows.

  % gem install sqlite3

 * Create a database for LesserWiki
   (You can find matching schemas in teh db/ folder)
 * Change the config/database.yml to reflect your newly created
   database configuration
 * Change the config/site.rb to correct site information
   (This configuration is used in RSS feed)
 * Change owner and permissions of cache folder to save cache files
 * Check the permissions of other folders and files
 * Rewrite ruby path of public/dispatch.* for your environment
 * Run script/server -e production and see if it works  
 * Point your browser to http://your.domain.com:3000/

Using FastCGI is recommended because if you use script/server script
(WEBrick) and IE, it is very slow to open a tiddler. 

To install FastCGI, follow the setup instructions on
http://wiki.rubyonrails.com/rails/show/FastCGI2

Upgrade
=======

See http://lesserwiki.org/tiddler/Upgrade

Usage
======

See http://lesserwiki.org/tiddler/Usage

Hint
====

If tiddler's contents is not updated, remove cache files in the cache
folder and try again.

Enjoy tiddling!
LesserWiki team
