
= Arrow

A Ruby web application framework for Apache.

== Authors

 * Michael Granger
 * Dave McCorkhill
 * Martin Chase

== Contributors

 * Aaron Son
 * Ben Bleything
 * Kim Wallmark

== General Information

Arrow is a web application framework for mod_ruby. It was designed to make
development of web applications under Apache easier and more fun without
sacrificing the power of being able to access the native Apache API.


== Online Docs

We're working on a manual which will provide more comprehensive instructions
and an in-depth tutorial. You can view it at:

  http://deveiate.org/projects/Arrow/manual/

We'd be happy to hear your suggestions, bug reports, or complaints.


== Installation

=== Requirements

* Apache (2.0 or 2.2) - http://httpd.apache.org/
* mod_ruby (>= 1.2.6) - http://modruby.net/

=== (Non-Standard) Ruby Library Dependencies

If you use RubyGems, appropriate versions can be installed using the
'install_dependencies' Rakefile task. Otherwise, you'll need to build and
install these by hand:

ruby-cache-0.3::      http://raa.ruby-lang.org/project/ruby-cache
formvalidator-0.1.4:: http://raa.ruby-lang.org/project/formvalidator
PluginFactory-1.0.3:: http://deveiate.org/projects/PluginFactory


==== Quickstart

Install:

  $ rake install

The install task will check for dependencies, install the libraries, and then offer some
advice about how to configure your server.


== Contact

* Project Page: http://deveiate.org/projects/Arrow


== Legal

Copyright  2003-2008 The FaerieMUD Consortium.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this list of
      conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above copyright notice, this list
      of conditions and the following disclaimer in the documentation and/or other
      materials provided with the distribution.

    * Neither the name of FaerieMUD nor the names of its contributors may be used
      to endorse or promote products derived from this software without specific prior
      written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


 $Id: README 459 2008-08-16 02:28:50Z deveiant $


