Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.18 KB

README.md

File metadata and controls

46 lines (30 loc) · 1.18 KB

SiardApi - An API for reading and writing files in the SIARD Format 2.1

This package contains an API for reading and writing files in the SIARD Format 2.1

Getting started (for devs)

For building the binaries, Java JDK (1.8 or higher) and Ant must have been installed.

Check build.properties and make changes according to your system. No special configuration should be necessary, if the java binaries are available in your $PATH.

Generate Siard 2.1 classes from metadata.xsd:

ant generate

Run all tests:

ant test

Create a release

ant release

this target also:

  • runs all tests.
  • copies siardapi.jar to the dist folder
  • updates MANIFEST.MF

IDEs

No specific IDE is needed.

Documentation

./doc/manual/user/index.html contains the manual for using the binaries. ./doc/manual/developer/index.html is the manual for developers wishing to build the binaries or work on the code.

More information about the build process can be found in doc/manual/developer/build.html.