Skip to content

Commit

Permalink
docs(profiling-node): add detailed docs on how to build bindings (#12900
Browse files Browse the repository at this point in the history
)

Add better build docs on how to build profiling binaries from source
#12899
  • Loading branch information
JonasBa authored Jul 12, 2024
1 parent 289d069 commit eaf6055
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions packages/profiling-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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).
Expand Down

0 comments on commit eaf6055

Please sign in to comment.