Skip to content

Commit 2756b3e

Browse files
committed
Readme updates!
1 parent 6e09549 commit 2756b3e

File tree

1 file changed

+29
-25
lines changed

1 file changed

+29
-25
lines changed

README.md

+29-25
Original file line numberDiff line numberDiff line change
@@ -26,25 +26,16 @@ This is a work in progress so the exported functions could change at any time be
2626

2727
## Installation
2828

29-
Please ensure you have the [required dependencies](https://github.com/nodejs/node-gyp#installation) before installing:
30-
31-
* Windows
32-
* Visual Studio 2013 (Express works fine).
33-
* Python (v2.7.3 recommended, v3.x.x is not supported).
34-
* Mac
35-
* Xcode Command Line Tools.
36-
* Linux
37-
* Python (v2.7 recommended, v3.x.x is not supported).
38-
* make.
39-
* A C/C++ compiler like GCC.
40-
* libxtst-dev and libpng++-dev (`sudo apt-get install libxtst-dev libpng++-dev`).
41-
42-
Then install RobotJS using npm:
29+
Install RobotJS using npm:
4330

4431
```
4532
npm install robotjs
4633
```
47-
I [plan on](https://github.com/octalmage/robotjs/issues/64) using node-pre-gyp to make this process easier.
34+
It's that easy! npm will download one of the prebuilt [binaries](https://github.com/octalmage/robotjs/releases/latest) your OS.
35+
36+
You can get npm [here](https://nodejs.org/en/download/) if you don't have it installed.
37+
38+
If you need to build RobotJS, see the [building](#building) section.
4839

4940
## Examples
5041

@@ -105,36 +96,49 @@ The [RobotJS API](https://github.com/octalmage/robotjs/wiki/Syntax) is contained
10596

10697
## Building
10798

108-
node-gyp is required to build RobotJS.
99+
Please ensure you have the required dependencies before installing:
100+
101+
* Windows
102+
* Visual Studio 2013 (Express works fine).
103+
* Python (v2.7.3 recommended, v3.x.x is not supported).
104+
* Mac
105+
* Xcode Command Line Tools.
106+
* Linux
107+
* Python (v2.7 recommended, v3.x.x is not supported).
108+
* make.
109+
* A C/C++ compiler like GCC.
110+
* libxtst-dev and libpng++-dev (`sudo apt-get install libxtst-dev libpng++-dev`).
109111

110112
Install node-gyp using npm:
111113

112114
```
113115
npm install -g node-gyp
114116
```
115117

116-
Then configure and build:
118+
Then build:
117119

118120
```
119-
node-gyp configure
120-
node-gyp build
121+
node-gyp rebuild
121122
```
122123

124+
See the [node-gyp readme](https://github.com/nodejs/node-gyp#installation) for more details.
125+
123126
## Plans
124127

125-
* Control the mouse by changing the mouse position, left/right clicking, and dragging.
126-
* Control the keyboard by pressing keys, holding keys down, and typing words.
127-
* Read pixel color from the screen and capture the screen.
128-
* Find image on screen, read pixels from image.
129-
* Possibly include window management?
128+
* Control the mouse by changing the mouse position, left/right clicking, and dragging.
129+
* Control the keyboard by pressing keys, holding keys down, and typing words.
130+
* Read pixel color from the screen and capture the screen.
131+
* Find an image on screen, read pixels from an image.
132+
* Possibly include window management?
130133

131134
## Progress
132135

133136
| Module | Status | Notes |
134137
| ------------- |-------------: | ------- |
135138
| Mouse | 100% | All planned features implemented. |
136139
| Keyboard | 100% | All planned features implemented. |
137-
| Screen | 10% | Screenshot, image search. |
140+
| Screen | 85% | Image search, pixel search. |
141+
| Bitmap | 0% | Saving/opening, png support. |
138142

139143
## FAQ
140144

0 commit comments

Comments
 (0)