/*
 * FAQ FRENZY
 * README - Generic readme and installation instructions.
 * Version 1.0, 15-Jan-04
 * Copyright 2004 Ross W. Poulton
 * ross@rossp.org
 * http://www.rossp.org/
 * 
 * This file is part of FAQ Frenzy.
 *
 * FAQ Frenzy is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * FAQ Frenzy is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Foobar; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 */

###########################
# 0. CONTENTS             #
###########################

	0. Contents
	1. About FAQ Frenzy
	2. Installation
	3. Support
	4. Licensing

###########################
# 1. ABOUT FAQ FRENZY     #
###########################

	FAQ Frenzy is the result of frustration in the lack of decent
	FAQ management systems available in PHP.

	FAQ Frenzy allows you to run your own FAQ index on your website, 
	and is ideal for company intranets, project homepages, or 
	special interest homepages.  It allows the creation of multiple
	categories of questions, which can be 'nested' within each other
	to an unlimited depth. Each category can contain an unlimited
	number of FAQ's.

	Each FAQ contains a summary, a description of the problem, and 
	a solution to the problem.  Most people should find this 
	sufficiently covers their FAQ needs.  In addition, it allows for
	the entry of extra searching keywords that an administrator 
	feels a user may search for, that aren't a part of the FAQ body
	itself. This allows precise searching by end-users.

	Lastly, each FAQ can have relationships built on it to other 
	FAQ entries. This means both FAQ's will be hotlinked to each 
	other when the end user views them.  This is idea for answering 
	problems that are different enough to warrant their own FAQ 
	entries, but similar enough that reading both responses may help
	the user more than just reading one.


###########################
# 1. INSTALLATION         #
###########################

	FAQ Frenzy is incredibly easy to install.  All you need to do is 
	edit the file named 'faqfrenzy.inc.php' to suit your database, 
	create your database inside MySQL, and then upload all of the 
	files to your webserver!

		1) Edit faqfrenzy.inc.php
			Open the file 'faqfrenzy.inc.php' in your favourite text
			editor, and change the database variables at the top of
			the file to suit your own server.

		2) Upload the files to your server
			Using SCP or FTP (or any other transfer method your host
			permits) upload all of the files to your website. I 
			recommend having FAQ Frenzy in its own database, but it 
			is up to you where you place it.

		3) Create your database
			How you do this will depend on your server.  Generally, 
			for recent versions of MySQL:

			# mysqladmin -uroot -p create [dbname]
			# mysql -uroot -p [dbname] < SQL

			For assistance with this, please speak to your database 
			server provider.

###########################
# 3. SUPPORT              #
###########################

	FAQ Frenzy is an UNSUPPORTED product. You must use it at your own
	peril.

	That said, I'm generally more than happy to answer quick questions
	via e-mail at ross@rossp.org. Note this is a privelage, not a right, 
	and I may not have a chance to get back to you. If I don't reply, 
	its most probably as I'm too busy. I apologise in advance for this.

	If you want modifications done, contact me at the above address 
	with what you want done. If I think its likely to be valuable to 
	the general community, I may do it and include it in the next  
	release of FAQ Frenzy.  If it is very website-specific, I'm happy
	to provide a quote to complete the work.

	Lastly, if you've done a modification that you believe is fantastic
	and that everyone should have it, please send it through - after a
	quick review I'll put it in the standard program and you'll get full 
	credit for your work.

###########################
# 4. LICENSING            #
###########################

	FAQ Frenzy is released under the terms of the GNU General Public 
	License (GNU GPL).  Please respect my work and this license. If you
	are too lazy to read the GPL, in the enclosed 'GPL' text file, a 
	brief rundown is here:
		* You may distribute the software as much as you like, providing 
		  you keep credit to me
		* You may modify the software as much as you like, providing you
		  credit me for my work (by all means, take credit for your own
		  work)
		* Any changes that are distributed must be done so under the 
		  terms of the GNU General Public License and must retain my 
		  copyright messages.

EOF
