init

lib_xassert/README.rst

@@ -0,0 +1,42 @@
+Lightweight assertions library
+==============================
+
+:Version: 4.2.0
+:Vendor: XMOS
+
+Overview
+--------
+
+This library provides a lightweight and flexible replacement for the
+standard C header ``assert.h``.
+
+The assertions in this library can be be enabled/disabled
+and configured as to how much information they show. This
+configuration can be per "xassert unit" (i.e. for sets of files).
+
+Features
+........
+
+  * Low memory usage
+  * Ability to enable or disable various features via compile time defines
+
+Software version and dependencies
+.................................
+
+The CHANGELOG contains information about the current and previous versions.
+For a list of direct dependencies, look for DEPENDENT_MODULES in lib_xassert/module_build_info.
+
+Required Software (dependencies)
+================================
+
+  * None
+
+Documentation
+=============
+
+You can find the documentation for this software in the /doc directory of the package.
+
+Support
+=======
+
+This package is supported by XMOS Ltd. Issues can be raised against the software at: http://www.xmos.com/support