Directory Structure

This page defines the directory structure standard used in this project. It is based on the recommendations in the developer.com article here. 

The Directories

The directories described below are relative to the project source tree, as would be checked out of SVN at http://svn.dprg.org/repos/roomba/roombacomm/trunk

Two trees are supplied by the project:
  1. the full developer tree, described below
  2. the user tree, which is the contents of the dist directory after building the full developer tree
The intent is that the dist directory contains everything a user needs to run the applications, but not the source. It is considered good practice to separate the runnable application from the source, which contains much more that users aren't typically interested in.
Directory Structure of /:
/ project root directory (run all tools from here)
 build.xml Ant build file
 lib/ jar files required for build
 src/ Java source code for servlets and utilities
 doc/ Project documentation, READMEs, HowTo's, etc
 build/ files compiled/copied into here (this directory can be safely deleted, and is not stored in the repository)
dist/ "ready to use" JAR's and other applications for users.

Directory Structure of /src:
com/hackingroomba/roombacomm Source directory of roombacomm library + applications
 scripts scripts to run the applications, and obsolete scripts that used to build the applications
 processing-examples contains directories for the /roombaring, /roombatune & /roombaview processing apps. These apps are intended to be copied as-is into a processing directory. (Processing is a graphic development environment - read "Hacking Roomba" for more details.)
processing-examples/roombaview In addition to the processing application, contains subdirectories which support the application. See fileDescriptions.
packaging ???A directory containing RoombaCommTest.app and directories which help a Mac build an app???

Directory Structure of /lib:
/ jar files which support roombacomm apps
/rxtx Files which provide serial I/O for java

Directory Structure of /dist: