==========================================================================
QuickBuild monitor 1.0 readme
==========================================================================

What is QuickBuild Monitor?
---------------
QuickBuild Monitor is Windows system tray application that monitors a build
status of specified QuickBuild configurations. It can notify the user about
interesting build events by playing a sound and by displaying a popup window
(depending on user defined notification conditions).


Prerequisites
-------------
1. Operating system: Windows 2000, Windows XP or Windows 2003.

2. Microsoft .NET framework 2.0 runtime (can be downloaded at
http://www.microsoft.com/downloads/details.aspx?FamilyID=0856eacb-4362-4b0d-8edd-aab15c5e04f5&displaylang=en)

3. Quickbuild version 1.2.0 or higher.


Installation guide
------------------
Extract quickbuildmonitor-1.0.0.zip and run quickbuildmonitor.exe.


User's guide
-----------
1. Add/Modify/Remove configurations to monitor.
   Click button "Edit Configurations" to bring up the configurations edit window.
   When adding a new configuration, following properties need to be specified:

   1) Quickbuild servlet URL
      Specifies the Quickbuild server, where the configuration to be monitored
      resides. For example, http://localhost:8080/quickbuild/app.do

   2) Configuration name
      Specifies the full name of the configuration to be monitored. For example,
      root.myfirstbuild

   3) User name, Password
      These two properties provide login information used to retrieve the status from
      the configuration. If not specified, anonymous user will be used.

   4) Notify condition
      Specifies when the user will be notified. Meanings of the most of the
      conditions are straitforward except the condition "CommitAndFailed". If
      this condition is specified, notification will be sent only when the latest
      build fails and the current user (specified in "User name" property) has
      made source code checkins recently.

   To delete particular configurations, just select them (clicking on the left side
   of desired configuration rows), and press "Delete" key on the keyboard.

2. Set auto refresh interval and browser path.
   Click button "Edit Settings" to specify the auto refresh interval and browser
   path. The "Auto refresh interval" determines how frequently the addin refreshes
   the status of the specified configurations. The "Browser path" setting is used to
   display configuration and build links (for example "C:\Program Files\Internet Explorer\iexplore.exe").

3. Refresh configuration status right away.
   Just click the "Refresh Now" button.

4. Pause monitoring of configurations.
   Just click the "Pause Monitoring" button. If the monitoring is paused, the addin will
   no longer poll configuration status periodically.

5. Resume monitoring of configurations.
   Just click the "Resume Monitoring" button.

6. The messages window.
   The messages window will display if you click on the "Messages" tab of the
   tool window. All history notification messages are displayed here, and you
   can delete them by selecting them and pressing the "Delete" key. Messages that
   are automatically selected represents the newest messages from the latest notification.

7. Trigger or stop particular configuration.
   Click on the "Trigger" or "Stop" button for particular configuration. The trigger
   action uses default setting (such as build version, build type etc.) for the
   configuration.

   NOTE: You can also trigger/stop current selected configuration from the context menu
         of the tray icon.

8. Display build status in the tray icon.
   Right click on the tray icon to display the context menu, open the
   "Current Configuration" sub menu to pick the configuration you want to display
   the build status for.

Build from source
-----------------
Extract quickbuildmonitor-1.0.0-src.zip. Open QuickbuildMonitor.sln with Visual
Studio 2005 to build and run the project.

==========================================================================
Thanks for using this plugin. Please visit http://www.pmease.com/Support.page
with any problems and/or suggestions.
==========================================================================