Fix Azure#297: Document Node.js version requirement for out-of-proc m…

…odules
damonbarry · Jun 7, 2017 · 7b3f15a · 7b3f15a
1 parent 2ca5dcc
commit 7b3f15a
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/doc/devbox_setup.md b/doc/devbox_setup.md
@@ -43,7 +43,7 @@ This section shows you how to set up a development environment for Azure IoT Edg
 
     ```
     sudo apt-get update 
-    sudo apt-get install curl build-essential libcurl4-openssl-dev git cmake libssl-dev uuid-dev valgrind libglib2.0-dev libtool autoconf
+    sudo apt-get install curl build-essential libcurl4-openssl-dev git cmake pkg-config libssl-dev uuid-dev valgrind libglib2.0-dev libtool autoconf
     ```
 
     > Note: libglib2.0-dev is required for ble module/sample.

diff --git a/proxy/gateway/nodejs/package.json b/proxy/gateway/nodejs/package.json
@@ -19,6 +19,9 @@
     "lint": "jshint --show-non-errors .",
     "test": "mocha"
   },
+  "engines": {
+    "node": ">=6.0.0"
+  },
   "author": "Microsoft",
   "license": "MIT"
 }
diff --git a/samples/nodejs_remote_sample/README.md b/samples/nodejs_remote_sample/README.md
@@ -12,13 +12,15 @@ This Node.js application uses the `azure-iot-proxy-gateway` package to act as an
 
 To run this sample:
 
+1. Install [Node.js](https://nodejs.org/en/download/) version 6.0 or later.
+
 1. Follow the instructions in the [proxy gateway sample](https://github.com/Azure/iot-edge/blob/master/samples/proxy_sample/README.md) to build and configure an IoT Edge application that communicates with an out-of-process module.
 
-2. In the `proxy/gateway/nodejs` folder, run `npm install` to install the package's dependencies.
+1. In the `proxy/gateway/nodejs` folder, run `npm install` to install the package's dependencies.
 
-3. In the `samples/nodejs_remote_sample` directory, run `npm install` to install the sample's dependencies.
+1. In the `samples/nodejs_remote_sample` directory, run `npm install` to install the sample's dependencies.
 
-4. Start the `proxy_gateway` app from one terminal like this:
+1. Start the `proxy_gateway` app from one terminal like this:
 
     ### Linux/Mac
     ```
@@ -32,7 +34,7 @@ To run this sample:
     Debug\proxy_sample.exe ..\..\..\samples\proxy_sample\src\proxy_sample_win.json
     ```
 
-5. Start the `nodejs_remote_sample` Node.js app from _another_ terminal like this:
+1. Start the `nodejs_remote_sample` Node.js app from _another_ terminal like this:
 
     ### Linux/Mac
     ```