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

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

System Requirements
===================

You need the following system to get LesserWiki to run.

* Rails 1.1 (1.1.2 is recommended)
* Rake 0.7 (0.7.1 is recommended)
* MySQL or PostgreSQL (Other DBs are not tested)
* DB adapter for Ruby

The following browsers are supported.

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

Currently Opera is not supported.

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

 0. Install required tools and libraries

   If you have not installed RubyGems, Rake and Rails, you have to install
   them first.
   
   Download RubyGems from http://rubyforge.org/frs/?group_id=126
   and follow the setup instructions of it.
   
   Execute the following.
   
    % gem install rails --include-dependencies
   
   If you have not installed a DB adapter for your DB, install it.
   
   MySQL:
   
       % gem install mysql
   
     If the above command fails, try this.
       % gem install mysql -- --with-mysql-config
   
   PostgreSQL:
   
       % gem install postgres

   If you want to use Markdown as a text formatting, you should install
   BlueCloth because RedCloth does not support Markdown sufficiently.
   
    % gem install bluecloth

 1. Unpack the zip in some directory.

 2. Create a database for LesserWiki

   MySQL:

       % mysql -u root
       mysql> create database lesserwiki default character set utf8;

     (You might have to specify password.)

   PostgreSQL:

       % createdb -E UNICODE lesserwiki

     (You might have to specify user and password.)

 3. Modify the config/database.yml to reflect your newly created database
   configuration

 4. Create tables in the database

   If you are using MySQL or PostgreSQL.

    % rake db:migrate

   If you are using another DB, try this.

    % rake db:schema:load

 5. Change owner and permissions of log and tmp directory
   
   tmp/cache, tmp/sockets, tmp/sessions and log directory must be writable
   for web server processes.
   You should also consider the security.

 6. Rewrite ruby path of public/dispatch.* for your environment

 7. Run script/server -e production and see if it works  

 8. Point your browser to http://localhost:3000/

 9. Create administrator account on the page

10. Save the settings on the administration page

11. Click "Go to Wiki" or go to http://localhost:3000/ again

After the above works, We recommend to setup FastCGI or SCGI because of
rendering performance.

Upgrade
=======

See UPGRADE file.

Usage
=====

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

Hint
====

LesserWiki saves cache of page fragments. If tiddler's contents is not
updated remove these caches.
You can remove caches by update settings on admin page or execute the
following command on terminal.

    % rake tmp:cache:clear

Enjoy!
LesserWiki team
