forked from RIOT-OS/RIOT
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request RIOT-OS#9968 from bergzand/pr/tinycbor/readme
tinycbor: add doc.txt file
- Loading branch information
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
* ``` | ||
*/ |