Skip to content

Commit eaf6055

Browse files
authored
docs(profiling-node): add detailed docs on how to build bindings (#12900)
Add better build docs on how to build profiling binaries from source #12899
1 parent 289d069 commit eaf6055

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

Diff for: packages/profiling-node/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ there is a fairly good chance this will work out of the box. The required packag
5656

5757
**Windows:** If you are building on windows, you may need to install windows-build-tools
5858

59+
**_Python:_** Python 3.12 is not supported yet so you will need a version of python that is lower than 3.12
60+
5961
```bash
6062

6163
# using yarn package manager
@@ -64,6 +66,22 @@ yarn global add windows-build-tools
6466
npm i -g windows-build-tools
6567
```
6668

69+
After you have installed the toolchain, you should be able to build the binaries from source
70+
71+
```bash
72+
# configure node-gyp using yarn
73+
yarn build:bindings:configure
74+
# or using npm
75+
npm run build:bindings:configure
76+
77+
# compile the binaries using yarn
78+
yarn build:bindings
79+
# or using npm
80+
npm run build:bindings
81+
```
82+
83+
After the binaries are built, you should see them inside the profiling-node/lib folder.
84+
6785
### Prebuilt binaries
6886

6987
We currently ship prebuilt binaries for a few of the most common platforms and node versions (v16-22).

0 commit comments

Comments
 (0)