Skip to content

Commit 3b8f365

Browse files
committed
update documentation
1 parent 3de4484 commit 3b8f365

File tree

2 files changed

+22
-10
lines changed

2 files changed

+22
-10
lines changed

INSTALL.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
## Automated installation with HedgehogBundle (recommended)
66

77
HedgehogBundle allows a very simple installation of the Hedgehog platform, the IDE can be installed via a single command.
8-
After cloning or downloading the bundle to the controller, simple enter the following two commands in the `HedgehogBundle` directory:
8+
After cloning or downloading the bundle to the controller, simply enter the following two commands in the `HedgehogBundle` directory:
99

1010
```bash
1111
$ cd ide
@@ -18,25 +18,37 @@ Now you are all set! The IDE should be running on port 80 of your controller and
1818
## Manual installation (only for advanced users)
1919

2020
In order to install the Hedgehog IDE manually on the Hedgehog controller, you first need to install Node.JS.
21-
To do so, open a terminal connection to your Hedgehog's Raspberry Pi, and type the following.
21+
To do so, open a terminal connection to your Hedgehog's Raspberry Pi.
22+
We recommend NVM for installing a node version:
23+
24+
```bash
25+
$ sudo aptitude -y install libssl-dev libzmq-dev libcurl4-gnutls-dev
26+
$ curl -L https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash
27+
28+
$ export NVM_DIR="$HOME/.nvm"
29+
$ . "$NVM_DIR/nvm.sh"
30+
$ nvm install 8.14.0
31+
```
32+
33+
Alternatively, download and install a distribution manually:
2234

2335
```bash
24-
$ wget https://nodejs.org/dist/v8.9.4/node-v8.9.4-linux-armv6l.tar.xz
25-
$ tar -xvf node-v8.9.4-linux-armv6l.tar.xz
26-
$ sudo cp -R node-v8.9.4-linux-armv6l/* /usr/local/
2736
$ sudo apt install libssl-dev libzmq-dev libcurl4-gnutls-dev
37+
$ wget https://nodejs.org/dist/v8.14.0/node-v8.14.0-linux-armv6l.tar.xz
38+
$ tar -xvf node-v8.14.0-linux-armv6l.tar.xz
39+
$ sudo cp -R node-v8.14.0-linux-armv6l/* /usr/local/
2840
```
2941

3042
Now you have the following options:
3143
- install an official release of the Hedgehog IDE
32-
- build the IDE from source for development
33-
- build the IDE from source and make your own production version
44+
- run the IDE in development mode
45+
- build the IDE from source and prepare a release
3446

3547
In each case, you will need to apply the correct configuration and set the `environment` option correctly.
3648

3749
### Installing a release
3850

39-
Simply download the latest release to your controller:
51+
Simply download and unpack the latest release to your controller:
4052

4153
```bash
4254
$ wget https://github.com/PRIArobotics/hedgehog-ide/releases/download/v1.3.0/hedgehog-ide-1.3.0-linux-armv7l.tar.gz
@@ -58,7 +70,7 @@ $ npm install
5870
### development mode
5971

6072
If you plan to work on the IDE itself and test changes frequently, this is what you want.
61-
The command will start a server and apply updates to any files automatically
73+
The command will start a server and apply updates to any files automatically.
6274

6375
```bash
6476
$ npm run develop

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ See [INSTALL.md](INSTALL.md) for setup & installation instructions.
1010

1111
## Development
1212
### Tools
13-
For following tools are used for development the Hedgehog IDE.
13+
The following tools are used for development the Hedgehog IDE.
1414
Thus, if you want to start working on the IDE, you will need to install them first.
1515
- Dependency Management: [NPM](https://www.npmjs.com/)
1616
- Build Automation: [Grunt](http://gruntjs.com/)

0 commit comments

Comments
 (0)