Skip to content

Commit

Permalink
Document node-gyp installation
Browse files Browse the repository at this point in the history
Adds note about installing dependencies for node-gyp.  Fixes #16
  • Loading branch information
baumandm committed Jan 24, 2017
1 parent 8f0ce98 commit ffa92e3
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ The `cyclotron-svc/` folder contains the REST API for Cyclotron, which interface

**Windows**: this may need to be run as an Administrator. Open the Node.js Command Prompt as an Administrator and run the command there.

**Windows/OSX/Linux**: node-gyp may require certain dependencies to be installed. See platform-specific instructions [here](https://github.com/nodejs/node-gyp#installation).

3. Create a configuration file at `cyclotron-svc/config/config.js`. A sample configuration file `sample.config.js` is provided:

cp config/sample.config.js config/config.js
Expand Down

0 comments on commit ffa92e3

Please sign in to comment.