Read Me

Copyright (c) 2008 Mike Farah

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, version 3.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

-------------------------------------------------------------------------------------------------------------------------
hudsonTracker (http://hudsontracker.sourceforge.net/index.html) - Created By Mike Farah
-------------------------------------------------------------------------------------------------------------------------

This application is a handy utility which monitors the status of your hudson projects. It does this by parsing the RSS feeds Hudson generates.



How to use
-------------------------------------------------------------------------------------------------------------------------
Run hudsonTracker.exe (Linux users, user the hudsonTracker.sh executable). This will put a tray icon on your system tray. If the icon is blue, then all the builds have passed, if it's red then there's a failure.

Mac users, run the hudsonTracker application, this will add an icon to the menu bar. If the 'hT' is white, then all the builds have passed. If it's grey, then there's
a failure. This application works best with Growl (http://growl.info/).

Right click to see the menu (Mac users left click). At the top of the menu is a list of your projects. Click on the projects to launch Hudson and view the last build details. Notice
that successful builds are prepended with "+" and failed builds are prepended with "-".

Below the separator are the program controls (which are self explanatory).

Double click the icon to open the Hudson home page in your browser. 


Tips and Tricks
-------------------------------------------------------------------------------------------------------------------------
- You can view a subset of of the projects on hudson by pointing hudsonTracker to the URL of a 'view' on Hudson, rather than the 
  Hudson homepage!

- You can hide the dock icon on a mac by using Dock Dodger (http://foggynoggin.com/dockdodger)


To configure:
-------------------------------------------------------------------------------------------------------------------------
In the application.properties file, you can configure:

	hudsonUrl to point to your hudson URL (e.g http://localhost:8080/). If you want, you can monitor a specific view by providing the view URL (e.g http://localhost:8080/view/myView/)

	refreshTime to the number of milliseconds you want hudsonTracker to check the RSS feeds. The default time is 1 minute (60000 milliseconds).

	maxRSSEntriesRead to the maximum number of RSS entries to read. If this is too small, hudsonTracker may not see some of your projects! Too large, and it may take a long time refreshing! The default is 1000.


Compiling the source code
-------------------------------------------------------------------------------------------------------------------------
hudsonTracker uses maven2 as the build manager. You will need to run 'deploy-maven-libaries.sh' to deploy 3rd party jars to your local maven repository (as these are not located on the standard online repositories)

To bundle the application, use "maven clean install -Dbundle"
Please note that this needs JDK 6.0 or above to work!