Skip to content

Commit

Permalink
Added detailed install instructions.
Browse files Browse the repository at this point in the history
I hope the README isn’t becoming too cluttered.
  • Loading branch information
octalmage committed Aug 4, 2015
1 parent ec1fd14 commit 2e9fc20
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,25 @@ This is a work in progress so the exported functions could change at any time be

## Installing

RobotJS uses [node-gyp](https://github.com/TooTallNate/node-gyp) for building. Please make sure you have the [required dependencies](https://github.com/TooTallNate/node-gyp/#installation) before installing.
Please make sure you have the [required dependencies](https://github.com/TooTallNate/node-gyp/#installation) before installing:

* Windows
* Visual Studio 2013 (Express works fine).
* Python (v2.7.3 recommended, v3.x.x is not supported).
* Mac
* Xcode Command Line Tools.
* Linux
* Python (v2.7 recommended, v3.x.x is not supported).
* make.
* A C/C++ compiler like GCC.
* libxtst-dev and libpng++-dev (`sudo apt-get install libxtst-dev libpng++-dev`).

Then install RobotJS using npm:

```
npm install robotjs
```
I [plan on](https://github.com/octalmage/robotjs/issues/64) using node-pre-gyp to make this process easier.

## Examples
Get the mouse location and move it.
Expand Down

0 comments on commit 2e9fc20

Please sign in to comment.