Skip to content

Commit

Permalink
README.md: Add important instructions to successfully install particl…
Browse files Browse the repository at this point in the history
…e-cli on some architectures/environments
  • Loading branch information
darcyparker committed Jul 20, 2021
1 parent 649f820 commit fe7a35e
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
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
> ```
1. Install dependencies `$ npm install`
1. View available commands `$ npm run`
1. Run the tests `$ npm test`
Expand Down

0 comments on commit fe7a35e

Please sign in to comment.