File: README

package info (click to toggle)
caveconverter 0~20170114-1
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 4,792 kB
  • sloc: java: 9,290; xml: 242; makefile: 18
file content (71 lines) | stat: -rw-r--r-- 2,905 bytes parent folder | download | duplicates (2)
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
Cave Converter
--------------
Copyright (C) 2009-2017 Paul Fretwell - aka 'Footleg' (drfootleg@gmail.com)

Cave Converter is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Cave Converter is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Cave Converter.  If not, see <http://www.gnu.org/licenses/>.

-------------------------------------------------------------------------------
Building from Source
--------------------
Cave Converter can be built from the Java source code using the provided ant 
build script. But first you will need to download some dependencies required 
to build the source, run the unit tests and generate code coverage reports for 
the tests.

apt-get install cobertura junit

build.xml expects to find these in the normal debian java library
directory below /usr/share/java/
 
(you can install newer versions from upstream and edit the paths in
the build.xml to point to the jar files if you want to use a different
location or version).

Once the dependencies are in place (and you have Java JDK 7 or later and Apache 
Ant 1.8 or later configured in your environment), you can run the following ant 
commands from a command prompt in the CaveConverter_src folder where you 
unzipped the source.
NOTE: To enable the ant script to work on Linux (Debian) with Open-JDK it was
necessary to define the env.JAVA_HOME property in the build.properties file.
This was not necessary when building on a Windows machine where the system 
environment variable JAVA_HOME was already pointing to a JDK.
To build on Debian I added this line to build.properties:
env.JAVA_HOME=/usr/lib/jvm/java-7-openjdk-amd64/

To build and run all tests, just type:
 ant
 
To just build the release distribution:
 ant zip

This should generate the jar file in a build folder, and a complete 
distributable zip file in a dist folder.

To run full unit and regression tests, and generate code coverage reports:
 ant coverage.regressions
 
To generate the Javadoc:
 ant javadoc
 
To do a full clean build and generate everything (this is the default target):
 ant all
 
Other primary ant targets can be listed by running:
 ant -p
 
Note that some internal targets will not work with the source distribution 
as they are related to code in development which is not yet functional :-)

This source package has been put together with the full code needed to build 
the command line cave converter tool using OpenJDK7