1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>DirectoryStructure</title>
</head>
<body>
<h1>Directory Structure</h1>
This page defines the directory structure standard used in this
project. It is based on the recommendations in the developer.com <a
href="http://www.developer.com/java/other/article.php/994991/Building-with-Ant-Directory-Structure.htm">article
here</a>.
<br>
<h2>The Directories</h2>
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<br>
<br>
Two trees are supplied by the project: <br>
<ol>
<li>the full developer tree, described below</li>
<li>the user tree, which is the contents of the dist directory after
building the full developer tree</li>
</ol>
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. <a
name="dir">
</a>
<table border="1">
<tbody>
<tr>
<th colspan="2">Directory Structure of /: </th>
</tr>
<tr>
<td>/ </td>
<td>project root directory
(run all tools from here) </td>
</tr>
<tr>
<td> build.xml </td>
<td>Ant build file </td>
</tr>
<tr>
<td> lib/ </td>
<td>jar files required for
build </td>
</tr>
<tr>
<td> src/ </td>
<td>Java source code for
servlets and utilities </td>
</tr>
<tr>
<td> doc/</td>
<td>Project documentation,
READMEs, HowTo's, etc</td>
</tr>
<tr>
<td> build/ </td>
<td>files compiled/copied
into here (this directory can be
safely deleted, and is not stored in the repository) </td>
</tr>
<tr>
<td>dist/</td>
<td>"ready to use" JAR's and other applications for
users.</td>
</tr>
</tbody>
</table>
<br>
<table style="width: 688px; height: 238px;" border="1">
<tbody>
<tr>
<th colspan="2">Directory Structure of /src: </th>
</tr>
<tr>
<td>com/hackingroomba/roombacomm </td>
<td>Source directory of roombacomm library + applications</td>
</tr>
<tr>
<td> scripts </td>
<td>scripts to run the applications, and obsolete scripts that
used to build the applications </td>
</tr>
<tr>
<td> processing-examples </td>
<td>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.)</td>
</tr>
<tr>
<td>processing-examples/roombaview</td>
<td>In addition to the processing application, contains
subdirectories which support the application. See fileDescriptions.</td>
</tr>
<tr>
<td>packaging</td>
<td>???A directory containing RoombaCommTest.app and directories
which help a Mac build an app???</td>
</tr>
</tbody>
</table>
<br>
<table style="width: 688px; height: 115px;" border="1">
<tbody>
<tr>
<th style="height: 34px;" colspan="2">Directory Structure of
/lib: </th>
</tr>
<tr>
<td style="height: 34px;">/</td>
<td style="height: 34px;">jar files which support roombacomm apps</td>
</tr>
<tr>
<td style="height: 35px;">/rxtx </td>
<td style="height: 35px;">Files which provide serial I/O for java</td>
</tr>
</tbody>
</table>
<br>
<table style="width: 688px; height: 115px;" border="1">
<tbody>
<tr>
<th style="height: 34px;" colspan="2">Directory Structure of
/dist: </th>
</tr>
<tr>
<td style="height: 34px;"></td>
<td style="height: 34px;"></td>
</tr>
<tr>
<td style="height: 35px;"></td>
<td style="height: 35px;"></td>
</tr>
</tbody>
</table>
<br>
</body>
</html>
|
