REQUIREMENTS
============

- A web server capable of running PHP (Apache will do fine).
- A PHP4 engine compiled with multibyte string support (--enable-mbstring),
  gettext (--with-gettext) and MySQL support (--with-mysql).
- A MySQL database server.

You can obtain them from the following locations:

Apache:	http://httpd.apache.org
PHP:	http://www.php.net
MySQL:	http://www.mysql.com

STEP-BY-STEP INSTALLATION
=========================

1) Unpack the software.

2) Open nikki.conf.php in your favourite text editor and set up the following
variables:

$prefix : Full path to the directory where you want to install O-Kiraku Nikki
(must be inside your HTTP document root).

$mysql_host : The IP or full qualified domain name of your MySQL server.

$mysql_user : Your MySQL user.

$mysql_password : Your MySQL password.

$mysql_database : The name of your MySQL database.

$default_language : The abbreviation of the language that will be displayed by
default in your calendar. Use 'en', 'es' or 'ja' for English, Spanish or
Japanese, respectively.

$post_login : Your user name for the control panel.

$post_password : Your password for the control panel.

3) Upload the files to your HTTP document root in your web server, maintaining
the directory structure.

4) Open your browser and access the nikki-install.php script. This will create
the calendar table:

http://yourdomain/nikki-install.php
-or-
http://yourdomain/~yourdirectory/nikki-install.php
-or-
http://yourdomain/otherdirectory/nikki-install.php

5) Delete nikki-install.php from your web server.

O-Kiraku Nikki should be now installed.

USAGE
=====

You can use the (very simple) included calendar, or you can integrate it into
your own web site.

1) Using the included calendar

If you want to use the included calendar, you can start using it right now by
opening http://yourdomain/nikki.php on your browser. You can link this page
from your website, or you can rename it to index.php if you'd like it to be
the default index for your web site. Or you can customize it as you want.

You can post messages in the calendar by opening
http://yourdomain/nikkipost.php in your browser. This script will ask you for
a login and password. These are the same that you configured before in 
nikki.conf.php. You can add new entries (you can add as many a you want in a
sigle day in the calendar), delete them, or modify existing ones.

2) Integrating O-Kiraku Nikki in your website

If you already have a website written in PHP, you can add a calendar to a
page by following these steps:

- Add this line at the beginning of your PHP script:

require 'nikki.inc.php';

- Add this line to the <HEAD> section of your HTML code:

<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">

- If you're using a CSS stylesheet, merge the contents of nikki.css into your
own CSS stylesheet.

- From the PHP script, add a call to calendar_display_month() where you want
the calendar to appear.

- From the PHP script, add a call to calendar_display_entries() where you want
to display the annotations for that day of the month.

Posting annotations to your calendar should be done through nikkipost.php.
