Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (41 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

61 lines (41 loc) · 1.41 KB
Raw

Contributing

We welcome help on this project, but please create all PRs with feature branches onto Master.

Requirements

Cmake > 3.12

Download latest stable cmake from: https://cmake.org/download/

Install:

cd ./cmake-3.15.4
./bootstrap
make -j
sudo make install

Development

The repository contains a few submodules:

To begin development, first clone the repository and related submodules

git clone --recursive https://github.com/s0l0ist/node-seal.git

cd node-seal

npm install

Inside package.json, we have several scripts to help generate the Web Assembly code.

First, initialize the Emscripten SDK build environment. This sets up a known working version of the SDK to build the project:

npm run update:submodule  # Pulls latest changes to emscripten
npm run update:emsdk      # Updates the tag information

Finally, configure the Microsoft SEAL build settings:

npm run build          # Will build the two MS-SEAL variants (allows, throws). Mac M1+ machines will need to install rosetta (`softwareupdate --install-rosetta`) for the closure compiler.
npm run compile        # Will run tsc on all *.ts files
npm run test           # Will run vitest on the *.ts files

To clean all generated artifacts:

npm run clean