Release Content

The release is came with two flavors:

  • The bin provides runnable tool and documentation
    • The all provides the same as the bin plus the source code and build scripts.

Here is the detail of the files contained in the release:

  • bin/log4j.xml : The log4j configuration used by the tool
  • bin/PiperTool.properties : The settings of the tool
  • bin/Run.bat : windows script to launch the tool
  • bin/Run.lnk : unix script to launche the tool.
  • doc/... : a locally browsable copy of the site
  • doc/index.html : The Documentation root page
  • lib/... : the java libraries used to run the tool
  • LICENSE-2.0.txt : The appache 2 licence text
  • log/... : The directory where the tool will log its activity
  • NOTICE.txt
  • ReleaseNote-file-piper-1.0-SNAPSHOT.txt : text version of the release note
  • src-projects/... : Sources = only present in the all bundles
  • src-projects/file-piper/... : the source and build script for the core tool.
  • src-projects/file-piper-example/... : the source and build script for the examples.

How to run the application

  • Download the release bundle from url: TODO
  • uncompress in a directory of your choice
  • Launch the run.bat or run.lnk (Windows machines) or run.sh (Unix machines)

How to build and run examples

  • To build the examples you need Apache Maven build tool. Download Maven (version = TODO) from apache software foundation site: TODO install it according provided installation instructions.
  • Download the all release bundle from url: TODO
  • uncompress in a directory of your choice
  • In the install dir/src-projects/file-piper-example run command "mvn install". This will build the examples and put the resulting jar in install dir/src-projects/file-piper-example/target/file-piper-example-version.jar
  • Copy the created file-piper-example-version.jar file to the install dir/lib directory.
  • Launch the tool as usual (see above). This time the tool will see the new Jar file and discover the example file processors it contains. Those processors will then be available in the processor list.