Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
amiechen committed Jul 30, 2018
1 parent fa82b51 commit 78d94d9
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@ Pretzel is Mac desktop app that shows and search keyboard shortcuts based on you

## Run it locally (if you are curious):

### Important! Because Pretzel has a dependency [node-ffi](https://github.com/node-ffi/node-ffi) that requires node v8, until `node-ffi` is compaitable with
latest node, you should use `nvm` to install node v8 to run Pretzel locally. Otherwise, `npm install` would give you some error regarding node-gyp.

```
nvm install 8.11.3 # I personally use this version
nvm ls # to make sure we are currently using node v8
npm install
npm start
```
Expand Down

0 comments on commit 78d94d9

Please sign in to comment.