Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Install notes for arm architectures #615

Merged
merged 3 commits into from
Jul 30, 2021
Merged

Install notes for arm architectures #615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e272867
.node-version and .nvmrc: Add .node-version file for use with node.js…
darcyparker Jul 20, 2021
649f820
package.json: Update node version in engines definition. particle-cli…
darcyparker Jul 20, 2021
fe7a35e
README.md: Add important instructions to successfully install particl…
darcyparker Jul 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .node-version
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v12.18.2
1 change: 1 addition & 0 deletions .nvmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.node-version
busticated marked this conversation as resolved.
Show resolved Hide resolved
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,20 @@ For the full list of commands, please see the [CLI command reference](https://do

1. Install Node.js [`node@12.x` and `npm@6.x` are required]
1. Clone this repository `$ git clone git@github.com:particle-iot/particle-cli.git && cd ./particle-cli`
1. Install dependencies required by some of particle-cli's npm dependencies

> particle-cli uses npm packages [`node-usb`](https://github.com/tessel/node-usb) and [`node-serialport`](https://github.com/serialport/node-serialport).
> On some environments (ie: Raspberry Pi and Apple M1), `node-serialport` [does not provide prebuild environments](https://github.com/serialport/node-serialport/issues/2292),
> so their npm install script relies on creating a prebuild using node-gyp (See
> [node-gyp requirements](https://github.com/nodejs/node-gyp#on-unix)), and libudev (See [node-usb installation](https://github.com/tessel/node-usb#installation).
> And these must be installed in order for their npm install script to succeed. As well, particle-cli uses dfu-util and openssl.
>
> As an example, to install these dependencies on Raspbian/Debian/Ubuntu:
> ```bash
> sudo apt update && sudo apt upgrade
> sudo apt install build-essential libudev-dev python3 dfu-util openssl
> ```
busticated marked this conversation as resolved.
Show resolved Hide resolved

1. Install dependencies `$ npm install`
1. View available commands `$ npm run`
1. Run the tests `$ npm test`
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@
"serialport": "^8.0.5"
},
"engines": {
"node": ">=8",
"node": "=12",
busticated marked this conversation as resolved.
Show resolved Hide resolved
"npm": ">=6"
},
"homepage": "https://github.com/particle-iot/particle-cli/",
Expand Down