-
Notifications
You must be signed in to change notification settings - Fork 3
/
README
151 lines (110 loc) · 4.86 KB
/
README
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
146
147
148
149
150
151
__ _ _____
/ _| __ ___ _| | _____|__ /
| |_ / _` \ \ /\ / / |/ / _ \ / /
| _| (_| |\ V V /| ( __// /_
|_| \__,_| \_/\_/ |_|\_\___/____|
_____________________________________________________________________
``A classic is something that everybody
wants to have read and nobody has read.''
-- Mark Twain
R E A D M E
This file gives a quick introduction into the fawkeZ project setup.
B U I L D I N G T H E P R O J E C T
PREREQUISITES
* Java Development Kit >= 1.4.0 and
* JRE >= 1.5.0 for the jCoderZ Report
* Ant >= 1.6.5
THIRD PARTY DEPENDENCY
o GraphViz [OPTIONAL]
http://www.graphviz.org/
The GraphViz package is required to render diagrams generated by the
documentation task. The 'dot' command line tool must be available
in the default path.
If you are behind a proxy, you need to configure the following Ant
properties:
o For proxy without proxy authentication:
proxyHost
proxyPort
o For proxy with proxy authentication:
proxyHost
proxyPort
proxyUser
proxyPass
You can put these properties in your user property file
(config/${user.name}.properties) or specify them on the ant command
line like this:
ant dist -DproxyHost=proxy -DproxyPort=80
and then fire up Ant
/path/to/ant/1.6.5/bin/ant dist
To execute the JUnit testcases, you need the junit.jar on your classpath:
export CLASSPATH=$CLASSPATH:/path/to/fawkez/lib/default/junit/junit.jar
D I R E C T O R Y L A Y O U T
This is a brief list of all the files in this directory and for what
they are used. Also includes major configuration files.
README
This file
AUTHORS
Project's authors.
CHANGES
Summarize changes that are 'visible' to the 'outside' (after
first release).
build.xml
Project build file includes config/properties.xml and
lib/ant.properties.
DIRECTORIES
build (*)
All files that are generated at compile time MUST be stored here.
Java source files that are generated by an idl compiler MUST be
stored here too.
Neither this directory itself nor any files in it are added to the
CVS system.
Subfolders like /build/classes, /build/docs, /build/gen-java,
will be created as used.
dist (*)
This directory is the one and only source for the productizing
team [and QA]. The "ready to productize" product will be and MUST
be stored here. Files that are not intended for distribution MUST
NOT be placed in this folder.
If there is a universal productizing subfolder structure, this
should be used.
Neither this directory itself nor any files in it are added to the
CVS system.
lib
Contains 3rd party jar Archive for the compile and test targets
that cannot be resolved dynamically.
lib/default (*)
Contains 3rd party jar Archive that are resolved dynamically.
docs
Development documentation (preferred 7-bit ASCII).
ASCII filenames should use upppercase letters and no extension,
e.g. TODO. See plain documentation style guide.
config
Compile time configuration for the Ant build process is stored here.
config/properties.xml
This file contains mostly static properties and path settings used
in the build.xml. Maybe overwritten by user specific property file.
src
Contains any sources. See below.
test
Contains any test related stuff e.g. JUnit Test, test-data or
test-scripts. See below.
tools
Contains project related tools used exclusive at compile time,
e.g. code generator, build-report-generator or cruise control
stuff. See below.
(src|tools|test)/java
Contains the java sources. Subfolders represent the java
packaging. So /java/com/jcoderz/foo/ is the lowest level
directory to put FOO related sources in. Classes in the test
directory matching the JUnit naming schema "*Test.java" must
contain valid JUnit testcases.
(src|tools|test)/sql
Contains all database create scripts needed for installation,
tools or testing.
(src|tools|test)/bin
Contains scripts.
(src|tools|test)/xml
Contains XML source. See subfolders.
(src|tools|test)/etc
Contains runtime configuration files.
(*) This directory is generated during the build process.