You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Please consult the project website at [nutjs.dev](https://nutjs.dev/docs/tutorial-first_steps/prerequisits) for in-depth tutorials
50
+
45
51
# Examples
46
52
47
53
[nut-tree/trailmix](https://github.com/nut-tree/trailmix) contains a set of ready to use examples which demo the usage ot nut.js.
@@ -50,10 +56,6 @@ Check out this demo video to get a first impression of what nut.js is capable of
50
56
51
57
nut.js provides [public API documentation](https://nut-tree.github.io/apidoc/) auto-generated by [TypeDoc](https://typedoc.org).
52
58
53
-
# Discussion
54
-
55
-
In [nut-tree/rfc](https://github.com/nut-tree/rfc) documents regarding larger design / implementation changes in nut.js are up for discussion.
56
-
57
59
# Community
58
60
59
61
Feel free to join our [Discord community](https://discord.gg/sJkN7789XR)
@@ -89,11 +91,11 @@ It's work in progress and will undergo constant modification.
89
91
90
92
## Screen
91
93
92
-
-[x] Find an image on screen
94
+
-[x] Find an image on screen (requires an additional provider package like e.g. [nut-tree/template-matcher](https://www.npmjs.com/package/@nut-tree/template-matcher))
93
95
-[x] Find all image occurrences on screen
94
-
-[x] Wait for an image to appear on screen
96
+
-[x] Wait for an image to appear on screen (requires an additional provider package like e.g. [nut-tree/template-matcher](https://www.npmjs.com/package/@nut-tree/template-matcher))
95
97
-[x] Retrieve RGBA color information on screen
96
-
-[x] Hooks to trigger actions based on images
98
+
-[x] Hooks to trigger actions based on images (requires an additional provider package like e.g. [nut-tree/template-matcher](https://www.npmjs.com/package/@nut-tree/template-matcher))
97
99
-[x] Highlighting screen regions
98
100
99
101
## Integration
@@ -103,12 +105,12 @@ It's work in progress and will undergo constant modification.
103
105
104
106
# Sample
105
107
106
-
The following snippet shows a valid `nut.js` example (on macOS)
108
+
The following snippet shows a valid `nut.js` example:
`nut.js` comes with a pre-built version of OpenCV for your respective target platform.
138
-
In order to use these pre-compiled bindings, certain runtime conditions have to be met.
139
-
140
136
## Prerequisites
141
137
142
138
This section lists runtime requirements for `nut.js` on the respective target platform.
143
-
`nut.js` is built and tested against node 10 and later as well as Electron 4 and later, so in order to use `nut.js` please make sure to use one of these versions.
0 commit comments