README

Concise Binary Object Representation (CBOR) Library
===================================================

Build TinyCBOR with Make
------------------------

```bash
  make
```

If you want to change the compiler or pass extra compiler flags:

```bash
  make CC=clang CFLAGS="-m32 -Oz" LDFLAGS="-m32"
```

Build TinyCBOR with CMake
-------------------------

```bash
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build .
```

### Compilation options

To configure your build use supported options by add them to the `cmake` invocation.

* Debug build:
  
```bash
cmake -DCMAKE_BUILD_TYPE=Debug ..
```

* Freestanding build (by default OFF):
  
```bash
cmake -DTINYCBOR_FREESTANDING_BUILD_ENABLED=ON ..
```

* Build static library (by default ON):

```bash
cmake -DUSE_STATIC_TINYCBOR_LIBRARY=ON ..
```

* Build shared library (by default OFF):

```bash
cmake -DUSE_SHARED_TINYCBOR_LIBRARY=ON ..
```

* Enable building of `json2cbor` and `cbordump`:

```bash
cmake -DENABLE_TOOLS=ON ..
```

The `json2cbor` tool is dependend on [cJSON](https://github.com/DaveGamble/cJSON) being available on your system.

### Testing

To build and run unit tests execute:

```bash
cmake -DENABLE_TESTING=ON ..
cmake --build .
ctest .
```

### Installation

```bash
cmake --install .
```

Documentation
-------------

<https://intel.github.io/tinycbor/current/>