Skip to content

README.md

Latest commit

 

History

History
57 lines (36 loc) · 1.39 KB

README.md

File metadata and controls

57 lines (36 loc) · 1.39 KB

Synapse C++ client

This repo contains the C++ client for the Synapse API. More information about the API can be found in the docs.

Building & Installing

Prerequisites

To build:

git submodule update --init

# Set up vcpkg -- you can also use a vcpkg elsewhere via VCPKG_ROOT
cd external/microsoft/vcpkg && ./bootstrap-vcpkg.sh && cd -
export VCPKG_ROOT="$(pwd)/external/microsoft/vcpkg}"

make all

# or
make clean
make configure
make build

To install

sudo make install

vcpkg

This project is also available as a vcpkg port.

To include this port in your project, add our overlay port repo to your vcpkg configuration (see 'Overlay ports').

Then you will be able to include it in your CMakelists:

synapse provides CMake targets:

  find_package(synapse CONFIG REQUIRED)
  target_link_libraries(main PRIVATE science::synapse)

Writing clients

This library offers a C++ interface to the Synapse API.

See the examples for more details.

https://github.com/sciencecorp/synapse-cpp/blob/main/examples/stream_out/main.cpp