An open API service indexing awesome lists of open source software.

https://github.com/steinwurf/bourne

json reader and writer
https://github.com/steinwurf/bourne

json json-reader-writer

Last synced: 11 months ago
JSON representation

json reader and writer

Awesome Lists containing this project

README

          

======
bourne
======

|Linux make-specs| |Windows make-specs| |MacOS make-specs| |Linux CMake| |Windows CMake| |MacOS CMake| |Raspberry Pi| |Valgrind| |No Assertions| |Clang Format| |Cppcheck|

.. |Linux make-specs| image:: https://github.com/steinwurf/bourne/actions/workflows/linux_mkspecs.yml/badge.svg
:target: https://github.com/steinwurf/bourne/actions/workflows/linux_mkspecs.yml

.. |Windows make-specs| image:: https://github.com/steinwurf/bourne/actions/workflows/windows_mkspecs.yml/badge.svg
:target: https://github.com/steinwurf/bourne/actions/workflows/windows_mkspecs.yml

.. |MacOS make-specs| image:: https://github.com/steinwurf/bourne/actions/workflows/macos_mkspecs.yml/badge.svg
:target: https://github.com/steinwurf/bourne/actions/workflows/macos_mkspecs.yml

.. |Linux CMake| image:: https://github.com/steinwurf/bourne/actions/workflows/linux_cmake.yml/badge.svg
:target: https://github.com/steinwurf/bourne/actions/workflows/linux_cmake.yml

.. |Windows CMake| image:: https://github.com/steinwurf/bourne/actions/workflows/windows_cmake.yml/badge.svg
:target: https://github.com/steinwurf/bourne/actions/workflows/windows_cmake.yml

.. |MacOS CMake| image:: https://github.com/steinwurf/bourne/actions/workflows/macos_cmake.yml/badge.svg
:target: https://github.com/steinwurf/bourne/actions/workflows/macos_cmake.yml

.. |Raspberry Pi| image:: https://github.com/steinwurf/bourne/actions/workflows/raspberry_pi.yml/badge.svg
:target: https://github.com/steinwurf/bourne/actions/workflows/raspberry_pi.yml

.. |Clang Format| image:: https://github.com/steinwurf/bourne/actions/workflows/clang-format.yml/badge.svg
:target: https://github.com/steinwurf/bourne/actions/workflows/clang-format.yml

.. |No Assertions| image:: https://github.com/steinwurf/bourne/actions/workflows/nodebug.yml/badge.svg
:target: https://github.com/steinwurf/bourne/actions/workflows/nodebug.yml

.. |Valgrind| image:: https://github.com/steinwurf/bourne/actions/workflows/valgrind.yml/badge.svg
:target: https://github.com/steinwurf/bourne/actions/workflows/valgrind.yml

.. |Cppcheck| image:: https://github.com/steinwurf/bourne/actions/workflows/cppcheck.yml/badge.svg
:target: https://github.com/steinwurf/bourne/actions/workflows/cppcheck.yml

.. image:: https://raw.githubusercontent.com/steinwurf/bourne/master/bourne.gif

A simple c++17 json reader and writer.

.. contents:: Table of Contents:
:local:

Usage
=====

Usage example is located in the examples folder.

Build
=====

Fetch the sources:

::

git clone https://github.com/steinwurf/bourne
cd bourne

We use the ``waf`` build system to build the bourne static library. We
have some additional waf tools which can be found at `waf
`_.

To configure and build bourne, run the following commands:

::

python waf configure
python waf build
python waf install --destdir=/tmp

The final ``install`` step will create a folder containing all the
nessecary files needed to use the library (e.g. static library,
headers etc.). You can change the output folder by passing a different
path to ``--destdir``:

Use as Dependency in CMake
==========================

To depend on this project when using the CMake build system, add the following
in your CMake build script:

::

add_subdirectory("/path/to/bourne" bourne)
target_link_libraries( steinwurf::bourne)

Where ```` is replaced by your target.

Credit
======

The code for this library have been inspired by the
`SimpleJSON `_
library.