Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 2.43 KB

BUILD.md

File metadata and controls

52 lines (38 loc) · 2.43 KB
Raw

Building the Project

The following steps should get your C SDK for Ziti building. C development is specific to your operating system and tool chain used. These steps should work properly for you but if your OS has variations you may need to adapt these steps accordingly.

Prerequisites

This repository expects the user to have at least a basic understanding of what a Ziti Network is. To use this library it is also required to have a functioning Ziti Network available to use. To learn more about what Ziti is or how to learn how to setup a Ziti Network head over to the official documentation site.

Building Requirements

  • cmake
  • make sure cmake is on your path or replace the following cmake commands with the fully qualified path to the binary
  • vcpkg is now used for dependencies.

Setting up vcpkg

To setup vcpkg you'll need to clone the actual vcpkg repository. The first step will have you set this environment variable. It should be set to somewhere durable, such as wherever you check your projects into. The example commands below use $HOME/%USERPROFILE% but you should probably change this to your liking.

Linux/MacOS:

  • set/export an environment variable named VCPKG_ROOT. for example (use an appropriate location): export VCPKG_ROOT=${HOME}/vcpkg
  • create the directory: mkdir -p ${VCPKG_ROOT}
  • clone the vcpkg project: git clone [email protected]:microsoft/vcpkg.git ${VCPKG_ROOT}
  • run the bootstrap-vcpkg for your platform: ${VCPKG_ROOT}/bootstrap-vcpkg.sh

Windows:

  • set/export an environment variable named VCPKG_ROOT. for example (use an appropriate location): SET VCPKG_ROOT=%USERPROFILE%\vcpkg
  • create the directory: mkdir %VCPKG_ROOT%
  • clone the vcpkg project: git clone [email protected]:microsoft/vcpkg.git %VCPKG_ROOT%
  • run the bootstrap-vcpkg for your platform: %VCPKG_ROOT%/bootstrap-vcpkg.bat

Building

Make sure you have setup vcpkg (see above). Building the SDK is accomplished with the following commands from the checkout root. Replace the --preset value with the one that matches your needs or create your own preset. You can run cmake from the checkout root with an unknown param passed to --preset to see the list of presets: cmake --preset unknown ${ZITI_SDK_C_ROOT}/.

Build the SDK with:

mkdir build
cd build
cmake --preset ci-linux-x64 ..
cmake --build .