Installation

Windows users can double click the RapidSpell.jar icon to see an example Swing application, or RapidSpellDesktopFX2.jar to see a sample FX application. To install RapidSpell so that you may use it in your application development requires two steps, you must add the RapidSpell Jar file ‘RapidSpell.jar' (Swing) or 'RapidSpellDesktopFX2.jar' (JavaFX) to your project class path and put ‘RapidSpellMDict.jar' in the same directory as RapidSpell.jar/RapidSpellDesktopFX2.jar. Exactly how you do this depends on your development environment;

For the command line compiler

• Copy the jar files to a convenient directory eg; c:\jars
• Specify the class path explicitly in your javac command
  eg; javac -classpath %classpath%;c:\jars\RapidSpell.jar MyApplication.java
• Specify the class path explicitly when running your application
  eg; java -cp %classpath%;c:\jars\RapidSpell.jar MyApplication

For the Ant build tool

• Copy RapidSpell.jar to the lib directory off of your project directory.
• Modify your build.xml file to add the Jar to your class path, to do this find the compile target:
  eg;

  <target name="compile" depends="init">
  ..........................
  </target>

  Within the compile target tags are ‘javac' tags which can contain ‘classpath' tags, inside the class path tags add this tag

  <pathelement location="lib/RapidSpell.jar"/>

  
  Which will give you something like the following;

  <target name="compile" depends="init">
  <copy todir="${build}">
    <fileset dir="${etc}"/>
  </copy>
  <javac srcdir="${src}" destdir="${build}">
    <classpath>
    <pathelement path="${classpath}"/>
  <pathelement location="lib/RapidSpell.jar"/>
    </classpath>
    </javac>
  </target>

• Modify your run.bat script to include the lib\RapidSpell.jar file in your class path
  eg; java -cp dist\lib\MyApp.jar;lib\RapidSpell.jar MyApp

For all IDEs

The principles in all the installation instructions outlined here are the same, put the RapidSpell.jar and RapidSpellMDict.jar files somewhere convenient and then add RapidSpell.jar to your project class path (as a library), your IDE will have detailed instructions on how to do this.

Once installed on your class path you are free to import the API in your project classes.