pre-requisites

The following needs to be installed on your system before you can start

1. Java 1.5+: make sure you set the JAVA_HOME environment variable correctly..
2. Graphviz. should be installed if you want Xuse to automatically produce diagrams from the requirements.

Download the released files

1. Download the latest version of the Xuse release files (see downloads for more information)
2. Windows
   1. Users are encouraged to use the installer Xuse-01.00.00-SNAPSHOT-2010-03-05-Setup.exe.
   2. Once downloaded run the executable and follow the installer instructions.
3. Linux
   1. Users should download the file Xuse-01.00.00-SNAPSHOT-2010-03-05-Linux-x86-Install
   2. Alter the permissions to make it executable.
   3. Execute and follow the on-screen instructions
   4. [Optional] add the following to .bashrc (or equivalent)

      #Xuse additions
      alias xuse=xuse.sh

   5. Occasionally there is a build error where the script does not work on *nix environments due to windows characters. This can be fixed with the following command: dos2unix $XUSE_HOME/bin/xuse.sh
4. For all other operating systems, download the zip file and then:
   1. Extract the zip file to a location of your choice.
   2. Create and environment variable XUSE_HOME for this location
   3. Add $XUSE_HOME/bin to the PATH
   4. [Optional for Unix/Linux environments] To make these environment variables permenant copy the following into your .bashrc (or equivalent) startup script.

      #Xuse additions
      XUSE_HOME=~/Xuse
      export XUSE_HOME
      
      if [ -d "$XUSE_HOME/bin" ] ; then
          PATH="$XUSE_HOME/bin:$PATH"
      fi
      
      alias xuse=xuse.sh

   5. On *nix: Set the shell script ($XUSE_HOME/bin/xuse.sh) to be executable - e.g. chmod +x $XUSE_HOME/bin/xuse.sh
   6. Occasionally there is a build error where the script does not work on *nix environments due to windows characters. This can be fixed with the following command: dos2unix $XUSE_HOME/bin/xuse.sh

Test Environment

The steps in this guide and Xuse itself have been tested on the following environments:

• Java 1.6_07 (SDK) / Windows Vista
• Java 1.5_14 (SDK) / Windows XP
• Java 1.6_16 (SDK) / Xubuntu 9.04
• Java 1.6_00 (openJDK) / Ubuntu 9.10

pre-requisites

The following needs to be installed on your system before you can start

1. Java 1.5.x SDK: make sure you set the JAVA_HOME environment variable correctly. Note it has to be the SDK not the JRE for Maven to work correctly.
2. Maven 2.x. Maven 2.0.9+ is recommended
3. Make sure Maven is up and running successfully before you proceed.
4. For first time Maven users you will need to type mvn -v to validate that Maven is installed correctly

Download the released files

1. Download the zip file containing the latest version of the Xuse release files to a lcoation of your choice e.g. c:\temp\xuse.
2. Unzip the contents of this file at the same location.
3. Run the install-mvn-xuse.bat or install-mvn-xuse.sh script for windows and linux systems respectively (note under linux you need to set the permissions to make is executable first).
4. Maven will run and install three files to your local repository.

Getting Started with Maven and Xuse

1. Navigate to a directory of your choice (the parent directory of where your new project will be created)
2. type the following command:
   
   (note: the \ are not part of the command just indicate that the line is being wrapped for presentation only - in reality this command is all on one line without the \ symbols):

   mvn archetype:create -DarchetypeGroupId=net.sourceforge.xuse \
     -DarchetypeArtifactId=maven-xuse-m2-plugin \
     -DarchetypeVersion=01.00.00-SNAPSHOT \
     -DgroupId=<your.groupId> \
     -DartifactId=<PROJECT_BASEDIR>
   

3. cd into PROJECT_BASEDIR.
4. A new project structure will have been created. .
5. From the PROJECT_BASEDIR type the following command:

     mvn net.sourceforge.xuse:maven-xuse-m2-plugin:xuse
   

   Note if you have a previously installed version of xuse you may need to specify the version too, e.g.

     mvn net.sourceforge.xuse:maven-xuse-m2-plugin:01.00.00-RC2:xuse
   

6. This will generate the HTML documentation.
7. Open up the HTML file at PROJECT_BASEDIR/target/docs/xuse/index.html and navigate through the examples.
8. Congratulations Xuse is installed correctly.