README for Tanager V2.0

This is Tanager V2.0, released 25 October 2006.

Tanager is a digital music player and is a case study in Object
Oriented Analysis and Design (OOAD) using iterative development
practices.  It is written as part of the requirements for my
Master of Science degree at Iowa State University.

For more information about Tanager, please see
  http://www.cs.iastate.edu/~rjlavey/Tanager


1.0 Executing Tanager from a fat jar file
=========================================
1) download the fat jar file from:
    www.cs.iastate.edu/~rjlavey/Tanager/Elaboration01/TanagerJava_fat.jar
2) make sure you have a JRE 1.5.0 (or later) loaded on your system
3) double-click the TanagerJava_fat.jar file


2.0 Building Tanager
====================
If you received Tanager as part of a zip file, you can build the
 executable from the source using Eclipse 3.2.

2.1 Prerequisites
-----------------
1) JRE 1.5.0 (or later) is installed
    (java.sun.com/javase/downloads/index_jdk5.jsp)
2) Eclipse 3.2 (or later) is installed (www.eclipse.org/)
3) if you want to run the unit tests, you'll also need to make sure
    JUnit 4.1 (or later) is installed (junit.sourceforge.net/)

2.2 Building/Executing in Eclipse
---------------------------------
1) download the zip file from
    www.cs.iastate.edu/~rjlavey/Tanager/Elaboration01/TanagerJEclipseProject.zip
2) create a new, empty Eclipse project named Tanager
3) import the zip file archive in to the Tanager Eclipse project
4) add the JavaPolygonButtons.jar file to the build path
5) add the JUnitNonPublicHelpers.jar file to the build path
6) execute as a java application using org.tanager.application.Tanager
    as the main class

 
3.0 User's Guide
================
Starting the Tanager player brings up a UI with 3 main sections:
  1) the text area that displays the current status of the player
  2) the control button area with the menu and on/off buttons
  3) the context-sensitive navigation button area with up, down,
      left, right, and middle buttons
Tanager can be powered off by pressing the On/Off button.
A song can be downloaded to Tanager by pressing the menu button and
 then selecting Download a Song from the displayed menu.
 
 
4.0 Troubleshooting
===================
If you hang with the Initializing message at power on, it's likely that
 you have an incompatible version of the TanagerSongCollection
 file in your working directory.  Try exiting the Tanager player,
 deleting the TanagerSongCollection file, and power on again.


5.0 Version History
===================
Version 2.0 - Elaboration Phase 1
  o The fat jar for this version of Tanager can be found at
     http://www.cs.iastate.edu/~rjlavey/Tanager/Elaboration01/TanagerJava_fat.jar
  o Implemented a basic scenario for the Power On use case: power on
     to default state.  No checking for saved system state is done.
  o Implemented a basic scenario for the Power Off use case: system
     state is not saved.
  o Implemented a basic scenario for the Download A Song use case:
     download a song with no error checking.  No checking for
     existence of music file is done.