Read Me

----- Introduction -----

BeeKeeper (v0.1) is a minesweeper clone written in Java, 
using only vector graphics (primitive shapes and lines).

The objective of the game is to collect all of the honey
without disturbing any of the dormant bees, as fast as possible.


----- Instructions -----

Before running the game, you must have Java (1.4 and above) installed on your system.

To launch the game, you must run the 'BeeKeeper.jar' file:
	- Via file explorer
		- Open the folder containing the file
		- Run by right clicking, and by selecting the appropriate option (depending on the system)
	- Via command line
		- Change directories to the folder containing the file
		- Run the command 'java -jar BeeKeeper.jar'	
		
The game comes with 3 difficulty levels:
	- Easy 
	- Medium
	- Hard

The amount of bees on the grid vary based on the difficulty level selected (default is easy)

The hexagons can be activated by using the left-click button on the mouse,
and can be flagged by using the right-click button.

The game also contains a 'smart-solver' that acts as an intelligent player, which can be activated by the middle click button.
It analyzes how many bombs and flags are surrounding the hexagon and expands the grid until it cannot analyze any further.

For example: If there are only two hexagons that are active surrounding another hexagon and the bee count indicates the
number "2", when middle clicking on the hexagon with the number, it will automatically flag the two hexagons,
and continue to expand the grid.


----- Developers -----

The source code for BeeKeeper (v0.1) is released under the GPL License (v3). 

In order to compile the project:
	- The Apache Ant tool must be installed (used to configure building)
	- A copy of the source code must be downloaded or checked out (via svn)
	- The current working directory of the command line must be changed to the folder containing the "build.xml" file

	The following build commands are available:
		- "clean" - removes all of the compiled content
		- "compile" - converts all of the .java files into .class files
		- "build" - packages all of the .class files into the java archive
		- "run" - runs all of the commands above and then launches the program

Developers are free to use any components of the game (such as the button or dialog system), but before doing so, please
read the "COPYING" document that was distributed with this game.

The game was coded with cross-compatibility in mind, so that all of the content should display and perform uniformly across all devices

If any improvements are made to the game and the developer would like to contribute their modification,
please contact any of the active contributors.

If there are any questions, concerns, or comments regarding this release, please contact me via Twitter (@Zer0Shad0w)