Skip to content

Commit 9c071ad

Browse files
committed
correct documentation, add target for running an IDE release
1 parent 1166531 commit 9c071ad

File tree

3 files changed

+42
-17
lines changed

3 files changed

+42
-17
lines changed

INSTALL.md

+38-13
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,38 @@ 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 run it
46+
- build the IDE from source and prepare a release
3447

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

3750
### Installing a release
3851

39-
Simply download the latest release to your controller:
52+
Simply download and unpack the latest release to your controller:
4053

4154
```bash
4255
$ wget https://github.com/PRIArobotics/hedgehog-ide/releases/download/v1.3.0/hedgehog-ide-1.3.0-linux-armv7l.tar.gz
@@ -58,22 +71,34 @@ $ npm install
5871
### development mode
5972

6073
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
74+
The command will start a server and apply updates to any files automatically.
6275

6376
```bash
6477
$ npm run develop
6578
```
6679

6780
Your configuration needs to use `environment: 'debug',`.
6881

69-
### production mode
82+
### building the IDE
83+
84+
With these commands, you build the IDE once and can then run it again multiple times.
85+
Changes to the source files will not affect the IDE until you rebuild.
86+
87+
```bash
88+
$ npm run build
89+
$ npm run start
90+
```
91+
92+
Your configuration needs to use `environment: 'production',`.
93+
94+
### preparing a release
7095

71-
If you want to build an optimized production build of the IDE, this is the right way.
72-
The commands here will first build a Hedgehog IDE release, and then start the webserver.
96+
To release a new version of the IDE, use these commands.
97+
Compared to `build`, `release` will apply some pruning to reduce size,
98+
and collect all files into the `release/` directory for packaging.
7399

74100
```bash
75101
$ npm run release
76-
$ npm start
77102
```
78103

79104
Your configuration needs to use `environment: 'production',`.

README.md

+1-1
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/)

package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
"test": "nyc mocha --require ts-node/register --reporter spec --check-leaks test/**/*.spec.ts",
88
"coveralls": "nyc report --reporter=text-lcov | ./node_modules/.bin/coveralls",
99
"develop": "./node_modules/grunt/bin/grunt",
10-
"build": "./node_modules/grunt/bin/grunt build",
11-
"release": "./node_modules/grunt/bin/grunt release",
1210
"gsl-blockly": "python -m gsl_blockly",
13-
"start": "node build/src/server/server.js"
11+
"build": "./node_modules/grunt/bin/grunt build",
12+
"start": "node build/src/server/server.js",
13+
"release": "./node_modules/grunt/bin/grunt release"
1414
},
1515
"repository": {
1616
"type": "git",

0 commit comments

Comments
 (0)