System Requirements

The software was tested to build on the following configuration:

  1. Windows XP Professional SP2 and  Ubuntu 7.04 Desktop Edition
  2.  Sun JDK 6.0
  3.  Eclipse SDK 3.3.1 with following plugins:
  4.  Maven 2.2.1

NOTES:

  • known to work also on Ubuntu 8.10/9.10 and on Eclipse SDK 3.4.1 + WST 3.0.2

Build Instructions

  1.  Checkout the wireXN project into some wirexn directory on your local disk
  2. Configure Maven according to the RequiredMavenSettings
  3. Open a command console on the wirexn directory and run mvn install on it

NOTES:

  • IMPORTANT: on Win32 system you must not use paths that contain spaces (e.g. if you have checked-out the project into the My Documents folder, then in most cases this folder is stored under C:\Documents and Settings\your-user-name\My Documents -- in this case you will have to relocate that folder, perhaps to C:\documents\your-user-name; software applications are usually located under C:\Program Files -- whenever you need to provide a path to some executable, you must provide it in short notation format, for example C:\PROGRA~1\whatever-application)
  • IMPORTANT: because of some PDE limitations the builder cannot find classes located in packaged plugin bundles, hence the %ECLIPSE_HOME%/plugins/org.mozilla.javascript_1.6.2.jar must be unpacked as %ECLIPSE_HOME%/plugins/org.mozilla.javascript_1.6.2 folder; on the p2 (since Eclipse 3.4) the ATF package must be unpacked in the dropins folder and the said "javascript" plugin unpacked before the IDE is started
  • currently, on *nix systems one of the automatic test fails -- see ticket #63 -- it is still possible to build the software by running mvn install -Dmaven.test.skip=true instead of what was described in (3) above

Enabling Eclipse Projects

  1. Enable basic Maven-Eclipse integration by running the  eclipse:add-maven-repo goal; see an example  here
  2. Open a command console on the wirexn directory and run mvn eclipse:eclipse on it
  3. Ensure that Eclipse uses the Sun JDK 6.0 for compilation -- see the Eclipse documentation  here
  4. You can now start importing wireXN projects into your Eclipse workspace
  5. If you have installed the  Eclipse Checkstyle Plugin then you should configure it to use the wireXN Checkstyle Configuration -- create an  external Checkstyle configuration, make it point to <wirexn-project>/build-extensions/src/main/resources/org/wirexn/build/extensions/wirexn-checks.xml and  configure each project to use that Checkstyle configuration; for additional configuration explanations you may read this  guide.