Keystone Eyrie Modular Runtime

Eyrie only builds as part of the Keystone sdk.

We strongly encourage using the top-level Keystone build process.

Building

Building the Eyrie Runtime

Make sure you've properly set the environment variable KEYSTONE_SDK_DIR to point to the Keystone SDK installation path.

Then, run ./build.sh [features].

Running the tests

Make sure you checked out all submodules with git submodule update --init.

Then, run make test.

If a test fails and you'd like more detail, enter into obj/test and run the binary for the failed test. e.g. if test_string fails, run obj/test/test_string.

Build options

See the sdk Makefile for feature selection.

Contributing

The Eyrie Runtime is licensed under the 3-clause BSD license. See LICENSE for more details.

Before submitting a pull request to GitHub, make sure you format your code first. You can use one of the following options:

git clang-format HEAD   # Formats any staged changes
git clang-format HEAD^  # Formats a single commit, and the staged changes
git clang-format HEAD~5 # Formats the past 5 commits (for example), and the staged changes

It's recommended that you use always the first option to format staged changes before committing, to keep changes clean.