Getting Started

Requirements

-JAVA SE Development Kit 7
-Apache ANT
-Git

An IDE, preferrably NetBeans IDE 8.

Please note: Proteus requires libraries and other projects that are not directly contained in its
git repository. You need to clone the maltcmsui repository, before you can use Proteus as a git
submodule.

Checking out (Read-Only)

git clone git://git.code.sf.net/p/maltcmsproteus/code proteus-code

Checking out (Read/Write)

git clone ssh://YOUR_SF_USERNAME@git.code.sf.net/p/maltcmsproteus/code proteus-code

or
git clone https://YOUR_SF_USERNAME@git.code.sf.net/p/maltcmsproteus/code proteus-code

Building proteus

Within the proteus directory, run

ant build

to build proteus. On the first invocation, a number of dependencies will be downloaded to
the platform-8.0 directory within the top level of the checked out project.

To run Proteus, run

ant run

To run the unit tests, run

ant test

Module Versioning

Make sure that implementation changes in modules are reflected in
updated micro version numbers! E.g. 1.0.0 -> 1.0.1

Make sure that api changes in modules are reflected by updated
minor version numbers! E.g. 1.0.0 -> 1.1.0

Make sure that incompatible api changes in modules are reflected by
updated major version numbers! E.g. 1.0.0 -> 2.0.0

Incompatible API changes usually involve restructuring of the module's
public APIs, so that legacy code would no longer compile against/work at runtime.

Increase the version within 'proteus/nbproject/project.properties'
to indicate a new application version:

app.version.major=1
app.version.minor=2
app.version.micro=1

Increase the micro version for bugfixes or minor functionality improvements.
Increase the minor version for new functionality.
Increase the major number for major new functionality and/or incompatible API changes.

Make sure that the 'site/' is updated to reflect the new release version (check paths).