Skip to content

Commit ded5ae9

Browse files
committed
update the readme
1 parent 80ac0b8 commit ded5ae9

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,24 @@ Install the client library using npm:
1414

1515
Install [node-gyp](https://github.com/nodejs/node-gyp) on the system and follow the the installation instructions.
1616

17-
Start the build process by `npm run build`.
17+
Start the build process by `npm run build:all`.
1818

1919
### Hotfixes for build issues
2020

2121
If the binding-compilation fails due to v8.h include errors is it required to delete the local cache of node-gyp.
2222
node-gyp cache: `%LocalAppData%/node-gyp/Cache`
2323
Thereafter execute `node-gyp configure` and the problem should be solved.
2424

25+
## Release steps
26+
27+
Some manual steps are required to release the package.
28+
These steps are required to avoid the creation a Windows-VM on Github.
29+
30+
- Build the bindings with Visual Studio on your local machine
31+
- Call `npm run build:rollup`
32+
- Commit and push the new generated *.node-bindings
33+
- Create a new tag on github and publish the release
34+
2535
## License
2636

2737
This software is licensed under the [MIT license](https://github.com/flybywiresim/api-client/blob/main/LICENSE).

0 commit comments

Comments
 (0)