This is RED, the Resource Expert Droid.

Copyright (c) 2008-2009 Mark Nottingham

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

* REQUIREMENTS

RED needs Python 2.5 or greater; see <http://python.org/>

It also needs a Web server that implements the CGI interface; e.g.,
Apache <http://httpd.apache.org/>.

Optionally, RED will take advantage of the pyevent extension, if installed.
See <http://code.google.com/p/pyevent/>.

* INSTALLING RED

Unpack the RED tarball. There are a number of interesting files;

  - src/webui.py - the Web frontend for RED. This is what is run by the server.
  - src/*.py - other Python files necessary for RED.
  - src/red_style.css - RED's CSS stylesheet.
  - src/jquery.js - the JQuery <http://jquery.com/> JavaScript library.

Place webui.py where you wish it to be served from the Web server. For example,
with Apache you can put it in a directory and add these configuration directives
(e.g., in .htaccess, if enabled):

  AddHandler cgi-script .py
  DirectoryIndex webui.py
  
If the directory is the root htdocs directory for your server "example.com", 
this will configure RED to be at the URI "http://example.com/".

red_style.css and jquery.js must be available at the same URI path as RED; 
in the deployment above, the easiest thing to do is to place them in the same
directory.

Finally, the other .py files must be available to Python; you can either place
them in the same directory, or somewhere else on your PYTHONPATH. See Python's
documentation for more information.

* SUPPORT, REPORTING ISSUES AND CONTRIBUTING

See <http://redbot.org/project> to give feedback, report issues, and contribute
to the project. You can also join the redbot-users mailing list there.