From 79ab7e69cde068f25c33d7b0e82d9935df1d7786 Mon Sep 17 00:00:00 2001 From: Garrett Summerfield Date: Mon, 1 Jul 2024 00:36:00 -0500 Subject: [PATCH] Update `README.md` Updated compile instructions and formatting. --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4a39dd2..b8c56bb 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,21 @@ 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` @@ -10,6 +24,6 @@ This package enables Node.js applications to use a CAN bus over USB. 4. Commit change to git 5. Run `git tag v` 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