Skip to content

Latest commit

 

History

History
38 lines (31 loc) · 949 Bytes

README.md

File metadata and controls

38 lines (31 loc) · 949 Bytes
Raw

Contents

This repo contains the following:

  • API specification in YaML
  • API programming guide in Markdown
  • API C/C++ header files (generated)
  • API Python module (generated)
  • Sample C++ wrapper (generated)
  • Sample C/C++ import library (generated)

Source Code Generation

Code is generated using included Python scripts.

Documentation

Documentation is generated from source code using Doxygen.

Third-Party Tools

Contains requirements for building spec. Compiler tools for building need to be manually installed for Windows.

Building

Project is defined using CMake.

Windows: Generating Visual Studio Project. EXE and binaries will be in build/bin/{build_config}

mkdir build
cd build
cmake {path_to_source_dir} -G "Visual Studio 15 2017 Win64"

Linux: Executable and binaries will be in build/bin

mkdir build
cd build
cmake {path_to_source_dir}
make