Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(profiling-node): add detailed docs on how to build bindings #12900

Merged
merged 1 commit into from
Jul 12, 2024
Merged

docs(profiling-node): add detailed docs on how to build bindings #12900

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions packages/profiling-node/README.md
View file
Open in desktop
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
Loading