*****
NOTE: If your company has a policy forbidding open source in your
product, all QP frameworks can be licensed commercially, in which case
you don't use any open source license and you do not violate your policy.
*****
Project Sub-Directories
=======================
QP Frameworks
-------------
QP-C - QP/C framework baseline code
QP-Cpp - QP/C++ framework baseline code
QP-nano - QP-nano framework baseline code
QM modeling tool
----------------
QM - Freeware QM graphical modeling tool
QP/C Development Kits (QDK-C):
-----------------------------
QDK-C_ARM-CM_CCS - QDK/C for ARM Cortex-M with Code Composer Studio
QDK-C_ThreadX - QDK/C for ThreadX RTOS
QDK-C_embOS - QDK/C for embOS RTOS
QDK-C_FreeRTOS - QDK/C for FreeRTOS
QDK-C_emWin - QDK/C for emWin embedded GUI
QDK-C_lwIP - QDK/C for lwIP TCP/IP stack
QP/C++ Development Kits (QDK-C++):
----------------------------------
QDK-Cpp_ARM-CM_CCS- QDK/C++ for ARM Cortex-M with Code Composer Studio
QDK-Cpp_ThreadX - QDK/C++ for ThreadX RTOS
QDK-Cpp_embOS - QDK/C++ for embOS RTOS
QDK-Cpp_FreeRTOS - QDK/C++ for FreeRTOS
QDK-Cpp_emWin - QDK/C++ for emWin embedded GUI
QDK-Cpp_lwIP - QDK/C++ for lwIP TCP/IP stack
QDK-Cpp_Qt - QDK/C++ for Qt GUI framework
QDK-Arduino - QDK for Arduino (QP/C++)
QP-nano Development Kits (QDK-nano):
------------------------------------
Miscellaneous:
--------------
doc - Documentation (books, manuals, application notes)
Qtools - Qtools collection for Windows and Linux
Win32-GUI_in_C - Win32-GUI kit for rapid prototyping embedded systems
QEP_Java - Java version the hierarchical event processor (QEP)
*****
NOTE: Further README files are provided in the project sub-directories.
*****
Installation
============
The installation instructions are provided in the README.txt files
inside the project sub-directories.
But generally, the last step of the installation is defining an
*environment variable* in your system to point to the installation
directory of a given component. For example, after installing the QP/C
framework, you should define the environment variable QPC to point to
the QP/C installation directory (e.g., C:\qp\qpc).
In case of the Qtools collection, you need to define the environment
variable QTOOLS and additionally you need to add the directory
%QTOOLS%\bin to your PATH variable.
Getting Started
===============
The easiest way to use QP is to start with one of the example projects
(located in the "examples" directory). That way you will have the
correct include paths, library paths, and compiler options configured.
Once an example application is building and executing you can start to
modify it *gradually* making sure that the project keeps working every
step of the way.
Version Compatibility and Revision History
==========================================
The QDKs (QP Development Kits) are labeled with the version of the QP
framework, which has been used to develop and test a given QDK. In
general, the QDKs remain compatible without any changes with any newer
version of the corresponding QP of the same major and minor version. For
example, QDK-C_ARM-CM_CCS version 5.3.0 is compatible with all QP-C
5.3.x releases.
The QDK might even remain compatible with newer QP version of a
different minor number, but this is not guaranteed and maybe some
(typically minor) changes to the QDK might be necessary.
The revision history of each component is provided at the end of the
README files inside the project sub-directories.
Help and Support
================
The project is supported via the Free Support Forum at:
http://sourceforge.net/p/qpc/discussion/668726
Bug Reports and Feature Requests
================================
Please use the Tickets menu.
Bug reports: https://sourceforge.net/p/qpc/bugs
Feature requests: https://sourceforge.net/p/qpc/feature-requests/
More Information
================
http://www.state-machine.com/quickstart - quick start guides for QP/QM
http://www.state-machine.com/qp - more information about QP
http://www.state-machine.com/qm - more information about QM
Contact Information:
====================
Quantum Leaps Website: http://www.state-machine.com
e-mail: info@state-machine.com