Install notes for arm architectures

darcyparker commented 3 years ago

Description

Update README.md with necessary instructions to install particle-cli on some environments such as those with ARM architecture. (ie Raspberry Pi)

As well, added .node-version and .nvmrc for use with node version managers. See https://github.com/shadowspawn/node-version-usage#node-version-file-usage.

Finally, I updated the engines property in package.json because it was outdated. In my experience particle-cli only works reliably with node v12. The README.md already notes this. But it is easy to gloss over this point in the README. So having it defined in package.json provides a better warning during install. And having a .nvmrc and .node-version helps users with a node version manager ensure they are using the correct version.

How to Test

Install particle-cli on a fresh install of Raspbian on a Raspberry Pi. It will fail to work properly if the OS dependencies mentioned in the updated README.md are not installed.

Completeness

[x] User is totes amazing for contributing!
[x] Contributor has signed CLA
[ ] Problem and solution clearly stated
[ ] Tests have been provided
[x] Docs have been updated
[ ] CI is passing

darcyparker commented 3 years ago

Note: The install script mentioned here: https://docs.particle.io/tutorials/developer-tools/cli/#using-macos-or-linux (https://raw.githubusercontent.com/spark/particle-cli-wrapper/master/installer/unix/install-cli) should probably be updated too. (https://github.com/particle-iot/particle-cli-wrapper/issues/15)

I suggest:

Checking ARCH=$(arch) results and if it contains arm, then install the additional dependencies mentioned in the README. I only provided an example for raspbian/debian/ubuntu. I do not have an Apple M1, so I did not work out the brew example.

darcyparker commented 3 years ago

I noticed the CI test is failing:

 AssertionError: expected [Function: functionStub] to have property 'callCount' of 0, but got 1

Is this a known intermediate error?

busticated commented 3 years ago

I noticed the CI test is failing:

yes, it's primarily due to a security precaution in our CI provider which i haven't been able to address quite yet.

AssertionError: expected [Function: functionStub] to have property 'callCount' of 0, but got 1

that specific failure is due to this change https://github.com/particle-iot/particle-cli/pull/615/commits/649f8206f1d49b6470400489230ce11065b4fe0c

darcyparker commented 3 years ago

just getting back from some PTO here - thanks for your patience. a few important notes below - if you prefer, i'm happy to take it over the finish line for you. thanks again 🙏 👍

Please do. I think you have the important information/intent of what I wanted to see fixed.

particle-iot / particle-cli