MagicDB is a web-based database designed for magicians to store their tricks

  Copyright 2007 Jean-Baptiste Hétier - djibux (at) think-underground.com

  This program 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 3 of the License, or
  (at your option) any later version.

  This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.


Index
=====
1. Installation
2. Quick start
3. Formatting text
4. User authentication
5. Known bugs
6. Planned features
7. Change Log


  Thank you for downloading this program. Don't hesitate to send me feedback,
  requests or bug reports.


1. Installation
===============
  The program was built using Ruby on Rails (http://www.rubyonrails.org/).

  * For Windows users, you may want to use InstantRails
    (http://instantrails.rubyforge.org/) that will pack up all you need
    to run this program (a database, a webserver, ...) 
  * For Linux users, I recommend Apache + Mongrel or simply the WEBrick
    server depending on your needs. You will also need a database like
    MySQL or PosgreSQL

  Don't forget to migrate the database. Alternatively you can use the
  mysql.sql file included with this project to create the database.


2. Quickstart
=============
  In MagicDB you will find the following:

  +-------------------+------------------------------------------------+
  | Link              | What you may want to put in it                 |
  +-------------------+------------------------------------------------+
  | Tricks            | Out of this World, Monte Carlo 74, ...         |
  | Magic Types       | Coin magic, Card magic, ...                    |
  | Categories        | Matrix, Ambitious card, Triumph, ...           |
  | Contexts          | Close-up, Street, Scene, ...                   |
  | Props             | Cards, Coins, Ropes, ...                       |
  | Techniques        | Overhand shuffle, Faro, ...                    |
  | Technique Types   | Control, Card Change, ...                      |
  | Publications      | Very Best Of Dai Vernon, Coin Magic vol.1, ... |
  | Publication Types | Book, DVD, Magazine, ...                       |
  | Authors           | Dai Vernon, David Stone, ...                   |
  | Notes             | Anything else :)                               |
  +-------------------+------------------------------------------------+

  I suggest you start by creating an Unknown author as well as an Unknown
  publication.
  You won't be able to create Tricks and Techniques if you don't have at least
  one element in every other table (except Notes).

  In the application, the number of spectators is the number of active
  spectators, ie. spectators that are actually doing something during the trick
  (picking a card, drawing something, blindfolding you, and so on...)


3. Formatting text
==================
  You can format the text you put in explanations, descriptions and so on using
  the following wiki-like syntax:
  
  [http://mylink.com]
  
  [Description|http://mylink.com]
  
  ==== Title ====

  __subscript__

  ¨¨superscribe¨¨

  **bold**

  ''italic''

  ! Important text

  @ Info box

  * bullet list

  # numbered list


4. User authentication
========================
  If you want to protect your application with user and password authentication
  you need to remove the # on the following line in file
  app/controllers/application.rb
    #before_filter :authorize, :except => :login


5. Known bugs
=============
  * There are some issues with the paging when multiple paging are on the same page.


6. Planned features
===================
  * Sortable lists
  * A search engine


7. Change Log
=============
  Version 0.3
  -----------
    * Program is now GPL
    * First public release
    * Adding props
    * Adding user authentication

  Version 0.2
  -----------
    * Adding notes
    * Adding wiki-like syntax

  Version 0.1
  -----------
    * First release