-------------------------------------------------------------------------------
--- OSGi Desktop - README -----------------------------------------------------
-------------------------------------------------------------------------------
- Contents --------------------------------------------------------------------

 1. Build Instructions
 2. Development Instructions
 3. Licensing
 
-------------------------------------------------------------------------------
- 1. Build Instructions -------------------------------------------------------

The project is setup to leverage Maven and Eclipse Plugin Development. The idea
being that once checked out and 'mvn clean install' is called you will have
every thing to run the application with Eclipse (it annoys me when there are
masses of instructions to follow). To ease this process I suggest you install
the the M2Eclipse plugin (http://m2eclipse.sonatype.org/) however it is
possible to call Maven from the command like to create all the required build
artifacts.

-------------------------------------------------------------------------------
- 2. Development Instructions -------------------------------------------------

 1.	To launch the application ensure that all items have been built via:

	mvn clean install
	
 2.	Open the 'Run Configurations' dialog from the toolbar or from the menubar
 	via:
 
 	Run > Run Configurations...
 	
 3.	Select the 'OSGi Framework' type in the left-hand menu and click on the
 	'New' button.
 4.	Ensure the 'osg-desktop' bundles appear and are selected in the 'Bundles'
 	table and de-select all the Eclipse bundles by clicking on the parent
 	selection check box. It does help to also have 'Validate Bundles prior to
 	launch' selected to give you an idea of what could be wrong as Equinox has
 	a tendency not to spit out errors on first start up.
 5. Click 'Run' to save and execute the application. This configuration will be
 	saved so you can execute the application and perform debug operations on
 	the project.
 	
-------------------------------------------------------------------------------
- 3. Licence ------------------------------------------------------------------

All the items within this project are licensed under the new BSD licence unless
the file is reproduced from another source. Any reproduced code will have it's
respective licence in file or if a type that cannot contain this will be
detailed in this file. I'm no licensing expert, so please report any
violations as soon as possible and I'll address the offending item.

 - 3.1 OSGiDesktop License -

So without further ado, the new BSD licence:

Copyright (c) 2007-2010, Daniel Siviter
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

	o Redistributions of source code must retain the above copyright notice,
	  this list of conditions and the following disclaimer.
	o Redistributions in binary form must reproduce the above copyright notice,
	  this list of conditions and the following disclaimer in the documentation
	  and/or other materials provided with the distribution.
	o Neither the name of Daniel Siviter nor the names of its contributors may
	  be used to endorse or promote products derived from this software without
	  specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 

 - 3.2 Crystal Project License -

Icons are from the Crystal Project (http://www.everaldo.com) released under
LGPL. It's too long to print, but here is the link:

	http://everaldo.com/crystal/?action=license

