Skip to content

Commit

Permalink
Merge pull request RIOT-OS#9968 from bergzand/pr/tinycbor/readme
Browse files Browse the repository at this point in the history
tinycbor: add doc.txt file
  • Loading branch information
cladmi authored Oct 1, 2018
2 parents 28c2a26 + 180917e commit be1c44e
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions pkg/tinycbor/doc.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/**
* @defgroup pkg_tinycbor TinyCBOR library
* @ingroup pkg
* @brief Provides the TinyCBOR (Concise Binary Object Representation)
* library
* @see https://github.com/intel/tinycbor/
*
* # TinyCBOR
*
* TinyCBOR is a CBOR encoder and decoder with a very small footprint, optimized
* for very fast operation.
*
* The main encoder and decoder functions don't use dynamic memory allocation.
*
* # Usage
*
* Just add it as a package in your application's Makefile:
*
* ```makefile
* USEPKG += tinycbor
* ```
*
* TinyCBOR has optional floating point support. In RIOT-OS this is enabled by
* adding the following line to your application's Makefile:
*
* ```makefile
* USEMODULE += tinycbor_float
* ```
*/

0 comments on commit be1c44e

Please sign in to comment.