Skip to content

Commit 79ab7e6

Browse files
Update README.md
Updated compile instructions and formatting.
1 parent 5140afc commit 79ab7e6

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,28 @@
22

33
This package enables Node.js applications to use a CAN bus over USB.
44

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)
620

721
1. Check out the `main` branch
822
2. Update `version` field in `package.json`
923
3. Run `npm install`
1024
4. Commit change to git
1125
5. Run `git tag v<version>`
1226
6. Run `git push`
13-
7. Run `git push --tags`
27+
7. Run `git push --tags`
1428
8. Run `npm publish --access public`
1529
9. Create a new release on GitHub with an explanation of the changes

0 commit comments

Comments
 (0)