From 840611f601a89abcde8ad05c42adefe9e8906266 Mon Sep 17 00:00:00 2001 From: JonasBa Date: Fri, 12 Jul 2024 12:16:32 -0400 Subject: [PATCH] profiling: add detailed docs on how to build bindings --- packages/profiling-node/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/packages/profiling-node/README.md b/packages/profiling-node/README.md index 7203752643ed..4357e23bb194 100644 --- a/packages/profiling-node/README.md +++ b/packages/profiling-node/README.md @@ -56,6 +56,8 @@ there is a fairly good chance this will work out of the box. The required packag **Windows:** If you are building on windows, you may need to install windows-build-tools +**_Python:_** Python 3.12 is not supported yet so you will need a version of python that is lower than 3.12 + ```bash # using yarn package manager @@ -64,6 +66,22 @@ yarn global add windows-build-tools npm i -g windows-build-tools ``` +After you have installed the toolchain, you should be able to build the binaries from source + +```bash +# configure node-gyp using yarn +yarn build:bindings:configure +# or using npm +npm run build:bindings:configure + +# compile the binaries using yarn +yarn build:bindings +# or using npm +npm run build:bindings +``` + +After the binaries are built, you should see them inside the profiling-node/lib folder. + ### Prebuilt binaries We currently ship prebuilt binaries for a few of the most common platforms and node versions (v16-22).