Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated compile instructions and formatting.
  • Loading branch information
garrettsummerfi3ld committed Jul 1, 2024
1 parent 5140afc commit 79ab7e6
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,28 @@

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

## Making a release
## Compiling

### Prerequisites

- Supported version of NodeJS (preferably a LTS version)
- A C/C++ compiler that supports C++20
- Internet connection to pull from upstream [CANBridge](https://github.com/unofficial-rev-port/CANBridge)

### Steps

1. Clone repository
2. Run `npm i` to install dependencies and compile the Node APIs
3. To test, run `npm run pretest` to prepare the testing and `npm test` to actually perform the testing of the repository

## Making a release (for repository owners)

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

0 comments on commit 79ab7e6

Please sign in to comment.