:orphan:

##############################
lib_unity: Template library
##############################

:vendor: XMOS
:version: 2.7.0
:scope: General Use
:description: A test framework for C, adapted from the Unity test framework
:category: General Purpose
:keywords:
:devices: xcore-200, xcore.ai

*******
Summary
*******

lib_unity is a small utility library that adapts the Unity unit test framework for use with the
xcommon_cmake-based XMOS build system.

********
Features
********

* xcommon_cmake support.
* LIB_UNITY_AUTO_TEST_RUNNER option for automatically generating test runners.

************
Known issues
************

* None

****************
Development repo
****************

* `lib_unity <https://www.github.com/xmos/lib_unity>`_ (https://www.github.com/xmos/lib_unity)

**************
Required tools
**************

* XMOS XTC Tools: 15.3.1

*********************************
Required libraries (dependencies)
*********************************

* Unity test framework (included as a submodule)

*************************
Related application notes
*************************

* None

*******
Support
*******

This package is supported by XMOS Ltd. Issues can be raised against the software at
`www.xmos.com/support <https://www.xmos.com/support>`_ or using GitHub `issues <https://github.com/xmos/lib_unity/issues>`_.
