Ruby Source Code (All platforms)
================================

The full RedBook source code is provided in a single zipped file, just uncompress it in a folder of your choice. The package contains the following folders and files:

* bin — This folder contains the following executable ruby files:
** redbook — The script to start RedBook in interactive mode.
** redbooklet — RedBooklet is a standalone ruby script, just for logging messages (suitable for integration with launchers like QuickSilver or Launchy).
* doc — This folder will contain RedBook's RDoc documentation.
* lib — This folder contains the "core" of RedBook, i.e. the most important source files.
* test — This folder contains some Unit Tests.
* config.yml — RedBook's configuration file in YAML format, used by both redbook.rb and redbooklet.rb
* log.yml — A default log file in YAML format (empty).
* .inputrc — An example .inputrc used by the Readline library.

Windows Executables
===================
RedBook and RedBooklet are also available in binary form. Ruby code cannot be compiled (yet), so the two executable files provided in this package simply include a whole, fully functional ruby interpreted and all the libraries needed to run the program (for more information, refer to RubyScript2Exe).

* start.bat - Use this to start RedBook (it enables auto-completion by setting the %INPUTRC% variable to point to your .inputrc file in the application directory).
* redbook.exe — The program to start RedBook in interactive mode.
* redbooklet.exe — The program used to simply log messages (suitable for integration with launchers like QuickSilver or Launchy).
* config.yml — RedBook's configuration file in YAML format, used by both redbook.rb and redbooklet.rb
* log.yml — A default log file in YAML format (empty).
* .inputrc — An example .inputrc used by the Readline library.

License
=======

See LICENSE.txt


Changelog
=========

See CHANGES.txt

Help
====

Refer to http://redbook.h3rald.com for additional help and information.