From 588a27203c6472d6b940735884896a4d4bfea807 Mon Sep 17 00:00:00 2001 From: Agost Biro Date: Fri, 7 Jun 2024 05:07:26 +0200 Subject: [PATCH] Add testing instructions --- CONTRIBUTING.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 836326b..c01756f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,13 +9,15 @@ The following software is required for local development (assuming MacOS ARM): # Building release binaries -The following is software is required to build release binaries (assuming MacOS ARM) : +The following is software is required to build release binaries (assuming MacOS +ARM) : - [Local development](#local-development) dependencies - Docker - [Taskfile](https://taskfile.dev/) -Then from the repo root use the following commands to build the release binaries that statically link the [native VDF](./vdf) for the supported platforms: +Then from the repo root use the following commands to build the release binaries +that statically link the [native VDF](./crates/vdf) for the supported platforms: ```shell task build_node_arm64_macos @@ -24,3 +26,9 @@ task build_node_arm64_macos ``` The output binaries will be in `node/build`. + +# Testing + +Testing the [`vdf`](./vdf) and [`node`](./node) packages requires linking the +[native VDF](./crates/vdf). The `test.sh` scripts in the respective directories +help with this.