Getting Started

Table of Contents

• Downloading & Installing QTools™
• Installing QTools™ on Windows
• Installing QTools™ on POSIX (Linux/MacOS)
• Directories and Files

Downloading & Installing QTools™

The most recommended way of obtaining QTools™ is by downloading the QP-bundle™, which includes QTools™ as well as all QP frameworks and also the QM™ modeling tool. The main advantage of obtaining QTools™ bundled together like that is that you get all components, tools and examples ready to go.

Note

QP-bundle™ is the most recommended way of downloading and installing QTools™.
It is also highly recommended that you keep checking the QP-bundle™ download page for newer releases.

Alternatively, you can download QTools™ separately as described below.

Installing QTools™ on Windows

On Windows, you simply unzip the qtools-windows_<x.y.z>.zip archive to the installation folder of your choice (C:\qp\qtools is the recommended default). After the installation, you still need to:

• add the <qtools>\bin and <qtools>\MinGW\bin directories to the global PATH on your system, where <qtools> denotes the directory where you have installed QTools (e.g., C:\qp\qtools\bin;C:\qp\qtools\MinGW\bin).

Note

Adding <qtools>\bin and <qtools>\MinGW\bin directories to your PATH will enable you to invoke all QTools utilities (like QSpy or QClean) by simply typing qspy or qclean at the command prompt, regardless of your current directory. This will come handy, because typically you will not invoke qspy or qclean from the <qtools>\bin directory.

• define the QTOOLS environment variable, for example:

set QTOOLS=C:\qp\qtools

Note

Defining the QTOOLS environment variable is required to run QUTest Unit Testing and QView Visualization and Monitoring utilities.

Installing QTools™ on POSIX (Linux/MacOS)

On POSIX (Linux/MacOS), you simply unzip the qtools-posix_<x.y.z>.zip archive to the installation folder of your choice (~/qp/qtools is the recommended default). After the installation, you still need to:

• add the <qtools>/bin directory to the global PATH on your system, where <qtools> denotes the directory where you have installed QTools (e.g., ~/qp/qtools).

Note

Adding <qtools>/bin to your PATH will enable you to invoke all QTools utilities (like QSpy or QClean) by simply typing qspy or qclean at the command prompt, regardless of your current directory. This will come handy, because typically you will not invoke qspy or qclean from the <qtools>/bin directory.

• define the QTOOLS environment variable, for example:

export QTOOLS=~/qp/qtools

Note

Defining the QTOOLS environment variable is required to run QUTest Unit Testing and QView Visualization and Monitoring utilities.

Directories and Files

The following annotated directory tree in the standard QTools™ distribution lists the top-level directories and files:

• qtools
  • bin — binaries (executables and libraries)
    • qspy.exe — QSPY executable
    • qclean.exe — QClean Code Whitespace Cleanup
    • qfsgen.exe — QFSGen ROM File-System Generator
    • ~ ~ ~
    • make.exe — make utility
    • rm.exe — rm (remove) utility
    • python.bat — Batch file to call Python
  • qspy — QSPY tool for software tracing and testing
    • include — QSPY includes
    • source — QSPY sources
    • posix — QSPY port to POSIX (Linux, macOS)
    • py — Python support (QUTest)
    • win32 — QSPY port to Windows
  •  
  • The following directories are present in QTools for Windows only
  • qwin — QWin™ GUI Prototyping Toolkit
  • MinGW — GNU C/C++ toolset for Windows (32-bit)
  • gnu_arm-none-eabi — GNU ARM-EABI toolset for Windows
  • Python38 — Python 3.8 for Windows

---

Next: QP/Spy™ Software Tracing