Read Me

 ____  _    _   _ ____  ____     ___  __  __ ____  
| __ )| |  | | | |  _ \| __ )   / _ \|  \/  / ___| 
|  _ \| |  | | | | |_) |  _ \  | | | | |\/| \___ \ 
| |_) | |__| |_| |  _ <| |_) | | |_| | |  | |___) |
|____/|_____\___/|_| \_\____/   \__\_\_|  |_|____/ 
  
 Copyright (c) 2006 Nicholas Farley, Alastair Lynn, Travis Bauscher
 

This document is organised into sections.

1.            Installing
1.1           Getting Blurb
1.2           Setting up your Database
1.3           Writing a Config File
1.4           Getting Styles

2.            Using Blurb
2.1           Ratings
2.2           Admin

3.            Contacting the Team

4.            Acknowledgments




1   Installing

As of yet (version 0.2) there is no installer for Blurb. We hope to have an installer by the next version. In the meantime, you will have to set up the database ourself.


1.1   Getting Blurb

To get the latest stable release:

http://www.sourceforge.net/projects/blurb/

To get the latest release from sourceforge, run this command:

svn checkout https://svn.sourceforge.net/blurb/src/


1.2   Setting up your Database

The SQL to create your database can be generated at http://blurb.sourceforge.net/schema.php


1.3   Writing a Config File

Open up the src/includes/config.php file in your favourite text editor.

Change the ROOT_DIRECTORY to the path to your Blurb installation. Do not end with a trailing slash.
Change the four DB settings to what they need to be for your configuration.
If you followed the default database schema, you can leave the TABLE options alone.
Change the SITE variables to what you wish to be displayed.
If you want a different date format, change the DATE_FORMAT to a PHP date() compatible format.
SHORT_QUOTE_MAXLEN is the number of letters in a short quote display before it cuts off and shows a link to a full display. 250 is a good number for this, change to taste.
QUOTES_PER_PAGE is the number of quotes on one page of short quotes. 20 is a good number for this.


1.4   Getting Styles

Styles can be seen on the Blurb QMS site - http://blurb.sourceforge.net/styles.php


2   Using Blurb

The interface for Blurb is fairly simple - play around with it.


2.1   Ratings

The Blurb QMS uses a system of ratings for each quote, to get a public opinion of how good they are. 


2.2   Admin

As of yet (version 0.2) there is no administration interface, so administration must be done through direct editing of the database.


3   Contacting the Team

You can contact us via IRC (#blurb on irc.uplinklabs.net) or e-mail.

Programmer - Alastair Lynn - IRC Nick: prophile - arplynn@gmail.com
Designer - Travis Bauscher - IRC Nick: Eegras - eegras@xenosgame.com
Admin - Nick Farley - IRC Nick: cia_man OR nfreader - farleyn@gmail.com


4.   Acknowledgments

Thanks to:
  script.aculo.us for the effects library
  Xenos for a live testing environment (www.xenosgame.com)
  OSWD for the default style (www.oswd.org)
    Specifically, NandoDevix of OSWD (devixdesign.com)