==========================================================================
QuickBuildMonitor 1.0 readme
==========================================================================

What is QuickBuildMonitor?
---------------
QuickBuildMonitor is a IntelliJ plugin that monitors a build status of specified 
QuickBuild configurations, and notify the user about interesting build events depending 
on user defined notify conditions).


Prerequisites
-------------
1. IntelliJ 6.0 or higher.
2. QuickBuild 1.2.0 or higher.

Installation guide
------------------
1. Copy the file quickbuildmonitor.zip to your installed Intellij plugins directory.
2. Extract quickbuildmonitor.zip to the current plugins directory.
3. Restart the Intellij and then open the settings, there you should see the icon of
   quickbuildmonitor.
4. To uninstall the plugin, you can either use Intellij plugin manager or just remove 
   the directory you just extracted.


User's guide
-----------
1. Configure QuickBuildMonitor
   1). Click settings button to open the settings dialog
   2). Click the icon of QuickBuild Configuration to bring up the settings dialog.
   3). In the dialog of QuickBuild Configuration, you can:
       a). Enable/Disable the QuickBuild Monitor.
       b). Enable/Disable the Auto Refresh. If you enable the auto-refresh feature,
           the monitor will auto-refresh the build status every seconds you set.
       c). Use the specified browser to open the latest build URL in the monitor, if you
           haven't set this option, the monitor will use the system default browser to
           open the latest build URL.
       d). Add/Remove/Edit the configurations.
           * Click the "+" button to add a Build Configuration, in the dialog, you can add
             a new configuration by fill in the following properties:
             -) Quickbuild servlet URL
                   Specifies the Quickbuild server, where the configuration to be monitored
                   resides. For example, http://localhost:8080/quickbuild/app.do

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

             -) 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.

             -) Notify condition
                   Specifies when the user will be notified. Meanings of 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.

           * Click the "-" button to remove a specified configuration.
           * Double click in the configuration list table to edit the selected configuration.


2. Use the Build Monitor to track the build status
   After finishing the configuration, you can track the build status during your development.
   1). The "Build Status" tab:
       a). Tracking the build status in the build list. There are five columns in the table:
           * The fist column is the latest build status.
           * "Config Name" which is the configuration name you set up before. Double Click this
             column to edit the configuration if you want.
           * "Latest Build" is the latest build of current configuration. Click this column will
             take you to the web page using the system default browser or using your specified
             browser defined in "QuickBuild Configuration" settings.
           * "Trigger" column can be used to trigger a particular configuration. The trigger
             action uses default setting (such as build version, build type etc.) for the
             configuration.
           * "Stop" column can be used to stop a particular configuration.

   2). The "Messages" tab:
       All history notification messages are displayed here, and you
       can delete them by pressing the "Clear" button in the toolbar. The latest message will be
       the first row of the list. If there is any error during the build, the message will be displayed
       as red color.

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

   4). Pause/Resume the monitoring of configuration
       You can just click the "Auto Refresh" button to Pause/Resume the monitoring.

Build from source
-----------------
1. Extract the quickbuildmonitor-1.0.0-src.zip.

2. Using Intellij 5.0 or higher to open the project.

3. Correct the module JDK to your own IDEA_JDK.

4. Build and run the project.

Or you can use ant to build the project (remember to change property "idea.home.dir" and 
"jdk.home.dir" in quickbuildmonitor.properties).

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