###############################################################################
# INSTALLATION                                                                #
###############################################################################

1. Decompress and put this folder somewhere inside your document root
2. If you want the directory to be called something other than "serendipity",
change the directory name now
3. Open serendipity in your browser (installer will say hi to you)
4. Serendipity ships world-writeable (777) to make installation easier.
After the install is complete,  you should change the permissions to allow
only your web-server user (e.g. Nobody) to access the serendipity directory.
If you have enabled file-upload and/or caching, you need to do something
like this:
  chown -R Nobody serendipity/
  chmod -R 744 serendipity/
because the web server needs to be able to write to directories inside the
distribution.  Otherwise, you should probably chmod -R 644 serendipity.
5. Done!

###############################################################################
# UPGRADE                                                                     #
###############################################################################

See README file for detailed actions.

###############################################################################
# REQUIREMENTS                                                                #
###############################################################################

1. The Apache Webserver
2. .htaccess support allowing overrides for DirectoryIndex
3. PHP Version 4 or greater (PHP 4.3.1 or greater recommended)
4. php.ini options:
   - error_reporting E_ALL & ~E_NOTICE (or lower)
   - file_uploads on (For import/image upload features)
5. Any of the following database engines:
   - Mysql
   - PostGreSQL
   - SQLite (not quite!)

###############################################################################
# FILE STRUCTURE                                                                #
###############################################################################
serendipity consists of 3 parts:

1. Function library / API
   -serendipity_admin_entries.inc.php
   -serendipity_admin_overview.inc.php
   -serendipity_config.inc.php
   -serendipity_functions.inc.php
   -lang/serendipity_lang_*.inc.php
   These files are never loaded in the browser, but included (as their
   suffix suggests).

3. Sample usage of the API
  -layout.php (in templates/[theme]/)
   This file displays the calendar, the search field, and the diary entries.
   You can either include this file somewhere in your site, or use the 
   callback functions directly in your site. It's up to you. I designed this,
   so you can quickly start off with a default layout :)

4. Dummy page
   -index.php
   This file "simulates" your homepage, you can safely ignore it, it is mainly
   for testing, whether serendipity works (currently it just prints a standard
   HTML header and includes layout.php

###############################################################################

Serendipity Weblog - http://s9y.org

Licensed under the BSD License

# $Id: INSTALL,v 1.9 2005/08/19 10:50:42 garvinhicking Exp $