Copyright 2006-2010 by Starling Software, K.K.
  This is part of QAM from http://www.starling-software.com.
  For license terms, see the LICENSE.QAM file included with this distribution.


Overview
========

The QAM application framework provides support for rapid development and
automated testing and deployment. One of the most powerful facilities of
this is "one-button" testing and deployment on fresh servers, ensuring
that all components are present and working, and letting you set up a
new test or production system in less than an hour-sometimes even just a
few minutes.

Further Documentation
=====================

More documentation, including an extensive document on the design and
operation principles of QAM, can be found in the src/qam/doc directory
under this directory.

Features
========

- Install program to assist in building third-party software such as
  Lighttpd, Mplayer, ImageMagic etc..
- Multiple server support
- Http unit test framework
- Tools for importing applications into subversion vendor tree.
- Tool for merging changes between multiple QAM projects.

Layout and Concepts
===================

Directory Structure
-------------------
    |-- Install
    |-- Test
    |-- build
    |-- extsrc
    |-- instance
    |-- release
    `-- src
	|-- Install
	|-- Test
	|-- db
	|-- qam
	|-- server.lighttpd

- Top Level: Is a project

- Test and Install: Test and Install run the subsequent Test and Install
  scripts in directories below or programs.

- extsrc: "External" software (libraries, servers, etc.) that the
  project uses with few or no changes. Standard build script knows how to
  build a whole lot of stuff.

- src: The project's source code; each module has its own directory
  underneath.

- build: Intermediate files used when compiling things, e.g., .o files.

- release: The installed software. Looks like a Unix hierarchy under
  /usr or /usr/local; bin, lib, etc. *Note* You can do a guaranteed clean
  build just by removing build and release; this is important when things
  get weird.

- instance: Contains subdirs holding run time information used by
  servers: config files customized for each program, temporary files, log
  files, database files, etc.

- src/qam: Contains the core libraries and programs for managing and
  updating your application with the QAM framwork.

- src/server.lighttpd: Holds the content and configuration files needed
  to configure and run a lighttpd web server.

Packages Required for Tests
===========================

Certain packages are not required by QAM itself, but are required to run
some of the tests included with QAM. The Ubuntu names of these packages
are given below, but other systems will be similar.

    libopenssl-ruby: for Ruby's net/https library.
    lighttpd: for the server startup and web request test framework tests