File tree Expand file tree Collapse file tree 1 file changed +16
-2
lines changed Expand file tree Collapse file tree 1 file changed +16
-2
lines changed Original file line number Diff line number Diff line change 2
2
3
3
This package enables Node.js applications to use a CAN bus over USB.
4
4
5
- ## Making a release
5
+ ## Compiling
6
+
7
+ ### Prerequisites
8
+
9
+ - Supported version of NodeJS (preferably a LTS version)
10
+ - A C/C++ compiler that supports C++20
11
+ - Internet connection to pull from upstream [ CANBridge] ( https://github.com/unofficial-rev-port/CANBridge )
12
+
13
+ ### Steps
14
+
15
+ 1 . Clone repository
16
+ 2 . Run ` npm i ` to install dependencies and compile the Node APIs
17
+ 3 . To test, run ` npm run pretest ` to prepare the testing and ` npm test ` to actually perform the testing of the repository
18
+
19
+ ## Making a release (for repository owners)
6
20
7
21
1 . Check out the ` main ` branch
8
22
2 . Update ` version ` field in ` package.json `
9
23
3 . Run ` npm install `
10
24
4 . Commit change to git
11
25
5 . Run ` git tag v<version> `
12
26
6 . Run ` git push `
13
- 7 . Run ` git push --tags `
27
+ 7 . Run ` git push --tags `
14
28
8 . Run ` npm publish --access public `
15
29
9 . Create a new release on GitHub with an explanation of the changes
You can’t perform that action at this time.
0 commit comments