Home | History | Annotate | Line # | Download | only in doc 
      1 
      2 
      3 This is the development reference of [libcbor](http://libcbor.org/). If you are looking for the user documentation, you should probably head to the [homepage](http://libcbor.org/).
      4 
      5 
      6 # Where to start
      7 
      8 A couple of pointers for you to start with: `0x00000000`, `0xDEADBEEF`.
      9 
     10 If you just want to peek under the hood, have a look at:
     11  - \ref src/cbor/common.h
     12  - \ref src/cbor/encoding.h
     13  - \ref src/cbor.h
     14 
     15 If you want to implement your own decoder or see how the default one is made:
     16  - \ref src/cbor/internal/builder_callbacks.h
     17  - \ref src/cbor/internal/stack.h
     18 
     19 For details on encoding and packing (could be useful when porting to exotic platforms):
     20  - \ref src/cbor/internal/encoders.h
     21  - \ref src/cbor/internal/loaders.h
     22 
     23 Streaming driver:
     24  - \ref src/cbor/streaming.h
     25 
     26 Manipulation routines for particular types:
     27  - \ref src/cbor/ints.h
     28  - \ref src/cbor/bytestrings.h
     29  - \ref src/cbor/strings.h
     30  - \ref src/cbor/arrays.h
     31  - \ref src/cbor/maps.h
     32  - \ref src/cbor/tags.h
     33  - \ref src/cbor/floats_ctrls.h
     34 
     35 # How to contribute
     36 
     37 Please refer to [the repository](https://github.com/PJK/libcbor)
     38