Skip to content
This repository has been archived by the owner on Oct 4, 2020. It is now read-only.

Latest commit

 

History

History
153 lines (107 loc) · 4.08 KB

installation.md

File metadata and controls

153 lines (107 loc) · 4.08 KB
Raw

Installation

C++ installation

Windows

Unix

For macOS you can use brew to install gcc by doing so : brew install gcc

CMake

CMake is an open-source, cross-platform family of tools designed to build, test and package software. CMake is used to control the software compilation process using simple platform and compiler independent configuration files, and generate native makefiles and workspaces that can be used in the compiler environment of your choice.

Install package with CMake

Head over to cmake.org or install it via Homebrew brew install cmake.

Once CMake properly installed, you can now build the package.

Client

git clone https://github.com/ArkEcosystem/cpp-client
cd cpp-client
mkdir build && cd build
cmake .
cmake --build .

Building and Running Tests

cd cpp-crypto/build
cmake -DUNIT_TEST=ON ..
cmake --build .
./test/ark_cpp_client_tests

Crypto

git clone https://github.com/ArkEcosystem/cpp-crypto
cd cpp-crypto
mkdir build && cd build
cmake .
cmake --build .

Building and Running Tests

cd cpp-crypto/build
cmake -DUNIT_TEST=ON ..
cmake --build .
./test/ark_cpp_crypto_tests

Arduino

Arduino is an open-source electronics platform based on easy-to-use hardware and software. It's intended for anyone making interactive projects.

Install package for Arduino

Download and install the Arduino IDE (>=1.8.5) from arduino.cc

Using the Arduino IDE's built-in Library Manager, install the ARK-Cpp-Crypto library. Be sure to install the "-arduino" version of Cpp-Crypto.

Dependencies

Using the Arduino IDE's built-in Library Manager, also install the following libraries:

Crypto

Using With the Arduino IDE

Include the following header in your Arduino Sketch:

#include <arkCrypto.h>

PlatformIO

An open source ecosystem for IoT development. Cross-platform IDE and unified debugger. Remote unit testing and firmware updates.

Install package for PlatformIO

Python is required to run PlatformIO, so grab an installer package from python.org.

Head over to platformio.org to learn how to install PlatformIO.

Once installed, add the following line to your platformio.ini configuration file:

Client

lib_deps = Ark-Cpp-Client

This is an example of a fully configured `platformio.ini file for the Adafruit ESP32 Feather:

; PlatformIO Project Configuration File
;
;   Build options: build flags, source filter
;   Upload options: custom upload port, speed and extra flags
;   Library options: dependencies, extra library storages
;   Advanced options: extra scripting
;
; Please visit documentation for the other options and examples
; https://docs.platformio.org/page/projectconf.html

[env:featheresp32]platform = espressif32
board = featheresp32
framework = arduino
lib_deps = Ark-Cpp-Client
upload_speed = 921600
monitor_speed = 115200

Crypto

lib_deps = Ark-Cpp-Crypto

This is an example of a fully configured `platformio.ini file for the Adafruit ESP32 Feather:

; PlatformIO Project Configuration File
;
;   Build options: build flags, source filter
;   Upload options: custom upload port, speed and extra flags
;   Library options: dependencies, extra library storages
;   Advanced options: extra scripting
;
; Please visit documentation for the other options and examples
; https://docs.platformio.org/page/projectconf.html

[env:featheresp32]platform = espressif32
board = featheresp32
framework = arduino
lib_deps = Ark-Cpp-Crypto
upload_speed = 921600
monitor_speed = 115200