Skip to content

Commit 3f912a7

Browse files
committed
Tidy up images and install/run docs
1 parent 8ce3f40 commit 3f912a7

File tree

5 files changed

+31
-17
lines changed

5 files changed

+31
-17
lines changed

docs/getting-started/installation.md

+24-11
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,37 @@ You can get the latest version from <http://nodejs.org/download/>.
1010
Or, you may want to use a version from your operating system's package manager:
1111
<https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager>
1212

13-
### Get Node-RED
13+
### Install Node-RED
1414

15-
There are several ways to install Node-RED. The simplest is to use npm.
15+
There are two ways to get Node-RED; either via npm, or directly from GitHub:
1616

17+
#### Using npm
18+
19+
$ mkdir node-red
20+
$ cd node-red
1721
$ npm install node-red
1822

19-
Or you can clone the repository from GitHub:
23+
This installs Node-RED, and its core dependencies into the `node_modules`
24+
directory.
2025

21-
$ git clone https://github.com/node-red/node-red.git
26+
Installing via npm also allows you to [embed Node-RED into an existing application](../embedding.html).
2227

23-
Or you can download the latest zip file from <https://github.com/node-red/node-red/archive/master.zip>.
28+
The version installed by npm is a point-in-time snapshot. To get the latest code run:
2429

25-
### Install the pre-requisite modules
30+
$ npm install node-red/node-red
2631

27-
From the top-level directory of Node-RED, run:
32+
#### From GitHub
2833

29-
$ npm install
34+
Either clone the repository:
35+
36+
$ git clone https://github.com/node-red/node-red.git
37+
38+
Or download the latest zip file from <https://github.com/node-red/node-red/archive/master.zip>.
3039

31-
This will install the core pre-requisite modules.
40+
Once downloaded, the core pre-requisite modules must be installed. From the top-level
41+
directory of Node-RED, run:
42+
43+
$ npm install
3244

3345
### Installing individual node dependencies
3446

@@ -40,8 +52,9 @@ Each will have its own set of dependencies that will need to be installed before
4052
the node is available in the palette.
4153

4254
To help identify the dependencies, Node-RED logs any modules it fails to find
43-
for a particular node. You don't have to install these unless you want or need
44-
that node to appear.
55+
for a particular node. You only need to install these dependencies if you want
56+
to use that node. For example, you probably don't want to install the `pi-gpio`
57+
module unless you are running on a Raspberry Pi.
4558

4659
Alternatively, a node's `.js` file can be examined to identify the modules it
4760
explicitly requires. For example, the Twitter node is defined in

docs/getting-started/running.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,17 @@ deployed configuration. You can point to a different flow file at start-up:
1414

1515
$ node red.js my_flows.json
1616

17-
You should now have a screen almost like this.
17+
18+
### Editor UI
1819

1920
![ScreenShot][1]
2021

2122
[1]: ../../images/node-red-screenshot2.png "ScreenShot"
2223

2324
The key areas are
2425

25-
1. The Pallette on the left - Nodes can be dragged from here to the main canvas.
26-
2. The Canvas or workarea - this is where you compose your flows.
27-
3. The Information and Debug window - this can be accessed via the Option button top right, or by the shortcut ctrl-space.
28-
4. The Deploy button - top right. This saves your flow and starts it running.
29-
5. The Options button - top right. This gives access to other functions such as import/export and the debug window.
26+
1. The node palette - nodes can be dragged from here on to the main canvas.
27+
2. The canvas or workarea - this is where you compose your flows.
28+
3. The sidebar, including information and debug tabs - this can be accessed via the Options button top right, or pressing Ctrl-Space.
29+
4. The Deploy button - this saves your flow and starts it running. It turns red when there are undeployed changes.
30+
5. The Options menu - this gives access to other functions such as import/export and the sidebar.

images/node-red-blank.png

80.8 KB
Loading

images/node-red-screenshot.png

3.31 KB
Loading

images/node-red-screenshot2.png

29.8 KB
Loading

0 commit comments

Comments
 (0)