3.2. Installing the New IDE

3.2.1. Installing the New IDE on Windows
3.2.2. Installing the New IDE on Linux
3.2.3. Installing the New IDE on Mac OS X
3.2.4. Using Squish
[Important]Squish 4.1 already includes the New IDE in Binary Packages

You only need to download and install the New IDE as described in this section if you installed the Squish Tools from source.

If you have downloaded a Squish 4.1 binary package the New IDE is already included. The New IDE's executable is SQUISHDIR\bin\squishide.exe on Windows, SQUISHDIR/bin/squishide on Unix, and SQUISHDIR/bin/squishide.app on Mac OS X. (For those who haven't yet migrated to the New IDE, the Classic IDE is still provided; it is in the SQUISHDIR/bin directory and is called squishclassicide.exe, squishclassicide, or squishclassicide.app depending on the platform.)

Once the command line tools are installed you can use the Squish IDE package to install the New IDE. If you want to use the New IDE, you must have a Java Runtime Environment (JRE), or a Java Development Kit (JDK), or both, installed on your machine (Java 1.5 or later). Java™ is available for free download from www.java.com so if you don't already have a JRE or JDK, the first thing to do is to download and install one of them. Once the JRE or JDK is installed (or was already installed), the Squish IDE can be installed. During the Squish IDE installation you'll be asked for the path to where the Squish tools are installed, so keep a note of what that path is.

The New IDE is provided in a ZIP file called squishide-version.zip. The version may vary, but will include text that identifies its target platform (win32, macosx, and so on). Download the ZIP file that is appropriate for your platform and then follow the platform-specific installation instructions given below.

The New IDE is uses the Eclipse libraries, so Eclipse users will find themselves at home straight away. If you are unfamiliar with Eclipse, we recommend going through one of the Squish tutorials, or at least reading the Perspectives and Views sidebar. (See also, the IDE Reference Manual (Chapter 17).)

3.2.1. Installing the New IDE on Windows

Once the IDE package is downloaded, unzip it in any convenient folder. You can probably uncompress the package using Window's built-in utilities. Start Windows Explorer and navigate to the folder that contains the IDE package. Right-click the package, and if you get an Extract All... option, click the option and use the Windows Extraction Wizard to uncompress the IDE package to the folder of your choice. If you don't have this option, you will need to obtain a ZIP uncompression tool. Several such tools are available, including the commercial WinZip and the open source UnZip from the InfoZip project.

Make sure that you have a Java Runtime Environment or a Java Development Kit installed (Java 1.5 or later), and that javaw.exe is in the %PATH%.

The New IDE's executable is in the unzipped folder's root and is called squishide; it can be run straight away from a console window:

C:\> cd squishide
C:\squishide> squishide.exe

For regular use you might prefer to create a shortcut to the executable from your Start menu or from your desktop.

[Note]The First Time the New IDE Runs

The first time the IDE is run it will ask you to choose the folder where the Squish tools are located. Choose the Squish tools' toplevel folder, i.e., the folder that contains the bin and lib folders. And if you forgot to run Squish's setup program after installing the Squish tools, the Squish IDE will automatically run it for you. Just go through the wizard as described in Configuring the Package (Section 3.1.1.2), after which the Squish IDE will start normally and you can begin working. And of course whenever you use Squish subsequently, it will start straight away.

Depending on your security settings, Windows might pop up a dialog asking if you want to allow or block the squishserver from running. If you get this dialog, you must choose Unblock for Squish to be able to function correctly.

3.2.2. Installing the New IDE on Linux

Once the IDE package is downloaded, unzip it in any convenient directory. (If you don't have unzip, install it using your system's package management tool.)

Make sure that you have a Java Runtime Environment or a Java Development Kit installed (Java 1.5 or later): use your system's package management tool to install one of them if you don't have one installed already.

The New IDE's executable is in the unzipped directory's root and is called squishide; it can be run straight away from an xterm:

$ cd squishide
$ ./squishide &

[Note]The First Time the New IDE Runs

The first time the IDE is run it will ask you to choose the directory where the Squish tools are located. And if you forgot to run Squish's setup program after installing the Squish tools, the Squish IDE will automatically run it for you. Just go through the wizard as described in Configuring the Package (Section 3.1.1.2), after which the Squish IDE will start normally and you can begin working. And of course whenever you use Squish subsequently, it will start straight away.

3.2.3. Installing the New IDE on Mac OS X

Once the IDE package is downloaded, unzip it in any convenient directory.

Make sure that you have a Java Runtime Environment or a Java Development Kit installed (Java 1.5 or later). On modern versions of Mac OS X one of them should already be present—if not, try installing Xcode.

The New IDE's executable is in the unzipped directory's root and is called squishide; it can be run straight away from inside a Terminal.app:

$ cd squishide
$ open squishide.app

[Note]The First Time the New IDE Runs

The first time the IDE is run it will ask you to choose the directory where the Squish tools are located. And if you forgot to run Squish's setup program after installing the Squish tools, the Squish IDE will automatically run it for you. Just go through the wizard as described in Configuring the Package (Section 3.1.1.2), after which the Squish IDE will start normally and you can begin working. And of course whenever you use Squish subsequently, it will start straight away.

3.2.4. Using Squish

If this is your first time using Squish, it might be a good idea to proceed to the most relevant tutorial so you can familiarize yourself with the software. Here are the most popular tutorials:

Note also that if you have multiple versions of the Squish tools installed (perhaps for different GUI toolkits or versions), you can switch between them in the Squish IDE. This is done by clicking Window|Preferences to invoke the Pref­er­ences dialog (Section 17.3.11), then clicking the Squish item in the left-hand list, and then choosing the Squish tools directory you want the Squish IDE to use.