jeans/etcher
jeans/etcher
1
0
Fork 0
mirror of https://github.com/balena-io/etcher.git synced 2025-07-29 06:06:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(CLI): describe proper way to install dependencies (#802)

Browse Source 
The `docs/CLI.md` points to user to `docs/CONTRIBUTING.md` for
instructions in how to install dependencies. This document previously
included the explicit `npm` commands to run, but was then changed to
point to the platform scripts, which means that if the user follows the
current instructions but has a NodeJS version which is not ABI
compatible with the NodeJS version used by the currently used Electron
version, the user will get an incompatibility error.

Fixes: https://github.com/resin-io/etcher/issues/801
Signed-off-by: Juan Cruz Viotti <jviotti@openmailbox.org>
This commit is contained in:
Juan Cruz Viotti 2016-10-31 19:45:21 -04:00 committed by GitHub
parent e603cb0838
commit 9e63639a53
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/CLI.md
View File

@ -20,8 +20,11 @@ you can run it locally with the following steps:
git clone https://github.com/resin-io/etcher git clone https://github.com/resin-io/etcher
``` ```
- Install the dependencies, using the instructions from - Install the dependencies by running:
[`RUNNING-LOCALLY.md`][RUNNING-LOCALLY].
```sh
npm install
```
- Run the Etcher CLI from `bin/etcher`. - Run the Etcher CLI from `bin/etcher`.
@ -71,5 +74,4 @@ The Etcher CLI uses certain exit codes to signal the result of the operation.
These are documented in [`lib/src/exit-codes.js`][exit-codes] and are also These are documented in [`lib/src/exit-codes.js`][exit-codes] and are also
printed on the Etcher CLI help page. printed on the Etcher CLI help page.
[RUNNING-LOCALLY]: https://github.com/resin-io/etcher/blob/master/docs/RUNNING-LOCALLY.md
[exit-codes]: https://github.com/resin-io/etcher/blob/master/lib/src/exit-codes.js [exit-codes]: https://github.com/resin-io/etcher/blob/master/lib/src/exit-codes.js