File	Date	Author	Commit
1 - Introduction	2014-02-04	Kevin Hufnagle	[c762c4] Added research and design discussion regarding ...
2 - Literature Review	2014-04-29	Kevin Hufnagle	[b72289] Began extensive work on Implementation chapter
3 - Design & Methodology	2014-05-03	Kevin Hufnagle	[48c840] Compiled first complete draft of report
4 - Implementation	2014-04-29	Kevin Hufnagle	[b72289] Began extensive work on Implementation chapter
5 - Results	2014-05-03	Kevin Hufnagle	[48c840] Compiled first complete draft of report
6 - Discussion	2014-02-04	Kevin Hufnagle	[c762c4] Added research and design discussion regarding ...
Figures	2014-04-22	Kevin Hufnagle	[a9abcc] Completed first partial draft of D&M chapter
Text in Figures	2014-02-17	Kevin Hufnagle	[02cd81] Added more detailed discussion about chamfer fe...
Hufnagle_MQP_Report_3-17-14.docx	2014-04-10	Kevin Hufnagle	[20f923] Added EndNote database; added beginning of Resu...
Hufnagle_MQP_Report_4-9-14.docx	2014-04-10	Kevin Hufnagle	[20f923] Added EndNote database; added beginning of Resu...
Hufnagle_MQP_Report_5-2-14.docx	2014-05-03	Kevin Hufnagle	[48c840] Compiled first complete draft of report
MQP Report Cross-References.xlsx	2014-04-22	Kevin Hufnagle	[cc08c6] Revised Literature Review chapter; began revisi...
MQP_writeup_guidelines.txt	2014-05-03	Kevin Hufnagle	[48c840] Compiled first complete draft of report
README.txt	2014-05-03	Kevin Hufnagle	[48c840] Compiled first complete draft of report
flickr_api_key.txt	2014-05-03	Kevin Hufnagle	[48c840] Compiled first complete draft of report
khufnagle_mqp.enl	2014-04-29	Kevin Hufnagle	[b72289] Began extensive work on Implementation chapter
mqp_2013.enl	2014-05-03	Kevin Hufnagle	[48c840] Compiled first complete draft of report
mqp_impl_todo.txt	2014-05-03	Kevin Hufnagle	[48c840] Compiled first complete draft of report
mqp_litrev_todo.txt	2014-05-03	Kevin Hufnagle	[48c840] Compiled first complete draft of report
mqp_litrev_todo.version1-22-14.txt	2014-05-03	Kevin Hufnagle	[48c840] Compiled first complete draft of report

Read Me

Kevin Hufnagle (WPI username = khufnagle)
May 1, 2014
Major Qualifying Project -- "Lighthouse Navigator" Android Application
Guide to Setting Up Development Environment

Table of Contents
=================
1. Brief Overview of Application
2. Components to Install on Machine
3. Steps for Executing the "Lighthouse Navigator" Application
4. Steps for Executing the Image-Processing Algorithms 

1. Brief Overview of Application
================================
This Android application enhances travel experiences to lighthouses across New
England, both before and during trips. Within this app, users can view:
* General facts about different lighthouses;
* Photographs that people have taken of the lighthouses;
* Historical events that have taken place at the lighthouses; and
* Reviews of the lighthouse sites from visitors.

In particular, the application comes bundled with an advanced set of
image-processing algorithms, which users could execute to filter the
photographs that appear within the application.

2. Components to Install on Machine
===================================
* Java Development Kit (JDK) -- Includes Java Runtime Environment (JRE) as well
  as debugging and development tools.
  http://www.oracle.com/technetwork/java/javase/downloads/index.html?
  ssSourceSiteId=otnjp

* Android Software Development Kit (SDK) -- Includes Android's APIs and
  Android SDK Manager, a portal for downloading additional Android tools
  http://developer.android.com/sdk/index.html?hl=sk

* Eclipse -- IDE for Java and Android development
  https://www.eclipse.org/downloads/

* Android Development Tools (ADT) Plug-In for Eclipse -- Offers more powerful
  Android development functionality within Eclipse
  http://developer.android.com/sdk/installing/installing-adt.html

* Files for the application itself -- The most recent copy of my application
  https://github.com/Kbhredsox/lighthousenavigator

* Android emulator or (better yet) a physical Android device -- For running
  the application
  http://developer.android.com/tools/devices/managing-avds.html

3. Steps for Executing the "Lighthouse Navigator" Application
=============================================================
1. Go to Sourceforge and download the most up-to-date version of the
   application (by selecting the "Download ZIP" button along the right-hand
   side of the page. Remember where you save the ZIP file on your local
   machine.
2. Open Eclipse and select the workspace where you would like the application
   files to reside. (Create a new workspace if this is your first time using
   Eclipse on this machine.)
3. Navigate to File > Import. The "Import" dialog appears.
4. Choose "General," then "Existing Projects into Workspace." Click "Next."
5. Near the top of this window, make sure the "Select archive file" radio
   button is enabled, then click "Browse" and find the ZIP file you
   downloaded in step 1. The projects associated with the application should
   appear in the "Projects" area of the window automatically.
6. Click "Finish." Eclipse imports the project files. Note that, because of the
   project's extensive size, this process could take a few minutes.
7. Expand the "LighthouseNavigator" project to view the application's files.
8. Right-click the "LighthouseNavigator" project and select Run As > Android
   Application. The "Android Device Chooser" dialog appears.
9. Select the device or virtual device you wish to use to run the application,
   then click "OK." The application's "Welcome" screen should appear on the
   device you selected.

4. Steps for Executing the Image-Processing Algorithms
======================================================
1. Complete steps 1-6 from the above set of directions.
2. Expand the "ImageJProcessor" project, then expand the "src" folder and the
   "edu.wpi.khufnagle.ij.drivers" package.
3. Right-click the driver corresponding to the image-processing algorithm you
   wish to demo and select Run As > Java Application. The program's output
   appears in the "Console" pane near the bottom of the Eclipse Workbench.

===EOF===