-------------------
              Developer Guide
              -------------------
              Jonas Haller
              -------------------
              07.01.2008
              -------------------

Developer Guide

* Contents

   [[1]] {{{#About}About this Guide}}

   [[2]] {{{#Getting}Getting Started}}

   [[3]] {{{#Project}Project Layout}}

   [[4]] {{{#Using}Using Maven}}


* {About} this Guide

  This guide is intended for developers who wish to work on Fosstrak Reader
  project. It outlines the steps to follow for setting up the development
  environment and helps developers to find their way through the code.


* {Getting} Started

  This section describes the setup of the development environment we use when
  working on Fosstrak's Reader project. To compile the Reader, execute Maven as
  explained below. A {{{http://java.sun.com/javase/downloads/}Java Development
  Kit}} needs to be installed.

** SVN Checkout

   First thing you need to do is checking out the code from the SVN repository.
   See {{{../source-repository.html}Source Repository}} on how to access the
   sources.

** Installing Maven

   We use {{{http://maven.apache.org/}Maven 2}} as our build tool.
   After installation you need to have the <<<M2_HOME>>> environment variable
   set to your Maven installation directory.


* {Project} Layout

  This section helps developers to find their way through the code.

** Project Modules

   Fosstrak's Reader project consists of three modules:

   * <<reader-rprm-core>>

     This module implements the EPCglobal Reader Protocol and Reader Management.
     It represents a compliant reader that uses the Fosstrak HAL with a simulator
     or reader hardware that does not support the Reader Protocol as backend.

   * <<reader-rp-proxy>>

     This module is a library for communication with a Reader Protocol compliant
     reader such as but not limited to the reader core module. The proxy depends
     on code of the reader core even if the reader of the core module is not
     used. An example of shared code located in the core module is the
     marshalling and unmarshalling of Reader Protocol messages that is used on
     both sides.

   * <<reader-rp-client>>

     This module provides a graphical user interface to configure a Reader
     Protocol compliant reader and two versions of an event sink that acts as
     a notification channel end point and displays information about events
     reported by the reader. The client depends on code of of the reader core
     and the proxy.

** Directory Layout

   We use the standard Maven directory layout as follows:

---------------------------------------------------------------------------
|
+-- pom.xml                             -> top-level POM file
|
+-- LICENSE.txt, README.txt
|
+-- src/
|   |
|   `-- site/                           -> project documentation
|
+-- reader-rprm-core/
|