Home | History | Annotate | Line # | Download | only in docs
      1  1.1  christos 
      2  1.1  christos 
      3  1.1  christos 
      4  1.1  christos <!DOCTYPE html>
      5  1.1  christos <html lang="en-us">
      6  1.1  christos   <head>
      7  1.1  christos     <meta charset="UTF-8">
      8  1.1  christos     <title>libcbor - CBOR format implementation</title>
      9  1.1  christos     <meta name="viewport" content="width=device-width, initial-scale=1">
     10  1.1  christos     <link rel="stylesheet" type="text/css" href="stylesheets/normalize.css" media="screen">
     11  1.1  christos     <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
     12  1.1  christos     <link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
     13  1.1  christos     <link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen">
     14  1.1  christos   </head>
     15  1.1  christos   <body>
     16  1.1  christos     <section class="page-header">
     17  1.1  christos       <h1 class="project-name">libcbor</h1>
     18  1.1  christos       <h2 class="project-tagline">CBOR format implementation for C &amp; others</h2>
     19  1.1  christos       <h2 class="project-tagline">Latest release: v0.5.0</h2>
     20  1.1  christos       <a href="https://github.com/PJK/libcbor" class="btn">View on GitHub</a>
     21  1.1  christos       <a href="https://github.com/PJK/libcbor/archive/v0.5.0.tar.gz" class="btn">Download source</a>
     22  1.1  christos       <a href="http://libcbor.readthedocs.io/en/v0.5.0/using.html" class="btn">Get started</a>
     23  1.1  christos     </section>
     24  1.1  christos 
     25  1.1  christos     <section class="main-content">
     26  1.1  christos 
     27  1.1  christos 
     28  1.1  christos <p><strong>libcbor</strong> is a C library for parsing and generating <a href="http://tools.ietf.org/html/rfc7049">CBOR</a>, the general-purpose schema-less binary data format.</p>
     29  1.1  christos 
     30  1.1  christos <h2>
     31  1.1  christos <a id="main-features" class="anchor" href="#main-features" aria-hidden="true"><span class="octicon octicon-link"></span></a>Main features</h2>
     32  1.1  christos 
     33  1.1  christos <ul>
     34  1.1  christos   <li>Complete RFC conformance</li>
     35  1.1  christos   <li>Robust portable C99 implementation</li>
     36  1.1  christos   <li>Layered architecture offers both control and convenience</li>
     37  1.1  christos   <li>Flexible memory management</li>
     38  1.1  christos   <li>Proper handling of UTF-8</li>
     39  1.1  christos   <li>Full support for streams &amp; incremental processing</li>
     40  1.1  christos   <li>Extensive documentation and test suite</li>
     41  1.1  christos   <li>No runtime dependencies, small footprint</li>
     42  1.1  christos   <li>Tested across architectures and operating systems</li>
     43  1.1  christos </ul>
     44  1.1  christos 
     45  1.1  christos <h2>A taste of the API</h2>
     46  1.1  christos <script src="https://gist.github.com/PJK/962a468886d24195d1ee.js"></script>
     47  1.1  christos 
     48  1.1  christos <h2><a id="distrib" class="anchor" href="#distrib" aria-hidden="true"><span class="octicon octicon-link"></span></a>Distribution</h2>
     49  1.1  christos 
     50  1.1  christos <h3>OS X</h3>
     51  1.1  christos <pre><code>brew tap pjk/libcbor
     52  1.1  christos brew install libcbor
     53  1.1  christos </code></pre>
     54  1.1  christos 
     55  1.1  christos <h3>Linux</h3>
     56  1.1  christos <p>
     57  1.1  christos   Please refer to <a href="http://libcbor.readthedocs.io/en/latest/getting_started.html">the documentation</a> on how to build <i>libcbor</i>.
     58  1.1  christos </p>
     59  1.1  christos 
     60  1.1  christos <p>
     61  1.1  christos   deb and RPM packages can be built effortlessly using <a href="https://cmake.org/cmake/help/v3.0/module/CPack.html">CPack</a>. <i>libcbor</i> also comes with <a href="https://www.freedesktop.org/wiki/Software/pkg-config/">pkg-config</a> support</li>.
     62  1.1  christos </p>
     63  1.1  christos 
     64  1.1  christos <h3>Windows</h3>
     65  1.1  christos <p>
     66  1.1  christos   Windows are supported and <a href="https://ci.appveyor.com/project/PJK/libcbor">tested for</a>. CMake can target both MSVC and Cygwin toolchains. Please refer to <a href="http://libcbor.readthedocs.io/en/latest/getting_started.html">the documentation</a> on how to do so.
     67  1.1  christos </p>
     68  1.1  christos 
     69  1.1  christos <h3>Other platforms</h3>
     70  1.1  christos <p>
     71  1.1  christos   As long as CMake and a C99 compiler are available, <i>libcbor</i> will work. Read more <a href="http://libcbor.readthedocs.io/en/latest/getting_started.html">here</a>.
     72  1.1  christos </p>
     73  1.1  christos 
     74  1.1  christos <h2>
     75  1.1  christos <a id="documentation" class="anchor" href="#documentation" aria-hidden="true"><span class="octicon octicon-link"></span></a>Resources &amp; documentation</h2>
     76  1.1  christos 
     77  1.1  christos <ul>
     78  1.1  christos   <li>User documentation is available online from <a href="http://libcbor.readthedocs.org/en/latest/">http://libcbor.readthedocs.org/en/latest/</a></li>
     79  1.1  christos   <li>Detailed build instructions are a part of the documentation</li>
     80  1.1  christos   <li>API reference is available either <a href="doxygen/index.html">online</a> or <a href="https://github.com/PJK/libcbor/releases/download/v0.5.0/libcbor_api_docs.tar.gz">as a part of the release</a></li>
     81  1.1  christos   <li><a href="https://github.com/PJK/libcbor/issues">Bug tracker</a>
     82  1.1  christos   <li><a href="https://github.com/PJK/libcbor/blob/master/CHANGELOG.md">Changelog</a>
     83  1.1  christos   <li><a href="https://github.com/PJK/libcbor/releases">Older releases</a>
     84  1.1  christos </ul>
     85  1.1  christos 
     86  1.1  christos <h2>Ruby bindings</h2>
     87  1.1  christos <p>If you write Ruby, you might be interested in the <a href="https://github.com/PJK/libcbor-ruby">Ruby bindings for <i>libcbor</i></a>.</p>
     88  1.1  christos 
     89  1.1  christos 
     90  1.1  christos <h2><a id="license" class="anchor" href="#license" aria-hidden="true"><span class="octicon octicon-link"></span></a>Licensing</h2>
     91  1.1  christos 
     92  1.1  christos <p><i>libcbor</i> is distributed under the terms of the MIT license, as found in the source code.</p>
     93  1.1  christos 
     94  1.1  christos <p>Copyright (c) Pavel Kalvoda, 2014 - 2017</p>
     95  1.1  christos 
     96  1.1  christos       <footer class="site-footer">
     97  1.1  christos         <span class="site-footer-owner"><a href="https://github.com/PJK/libcbor">libcbor</a> is maintained by <a href="https://github.com/PJK">PJK</a>.</span>
     98  1.1  christos         <span class="site-footer-credits">This page is based on the <a href="https://github.com/jasonlong/cayman-theme">Cayman theme</a> by <a href="https://twitter.com/jasonlong">Jason Long</a>.</span>
     99  1.1  christos       </footer>
    100  1.1  christos 
    101  1.1  christos     </section>
    102  1.1  christos 
    103  1.1  christos <script>
    104  1.1  christos   (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
    105  1.1  christos   (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
    106  1.1  christos   m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
    107  1.1  christos   })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
    108  1.1  christos 
    109  1.1  christos   ga('create', 'UA-8187884-5', 'auto');
    110  1.1  christos   ga('send', 'pageview');
    111  1.1  christos 
    112  1.1  christos </script>
    113  1.1  christos   </body>
    114  1.1  christos </html>
    115