Xuse Installation Guide

This guide covers the intallation of Xuse version 00.03.XX. To see the installation instructions for version 00.02.00 please review the instructions here.

This document covers a basic installation of Xuse. There are two alternative installs for Xuse 00.03.XX:

Xuse standalone

This section describes how to install Xuse for xuse on the command line.

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 users are encouraged to use the installer. Once downloaded run the executable and follow the installer instructions.
  3. 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

Test Environment

The steps in this guide 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) / Xubunto 9.04

Getting Started

Please see the Getting started guide.