Skip to content

Commit 6f37c73

Browse files
committed
[skip travis] Updated readme with installation instructions
1 parent 14b55ca commit 6f37c73

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# nut.js (Native UI Toolkit) [![Build Status](https://travis-ci.com/nut-tree/nut.js.svg?branch=master)](https://travis-ci.com/nut-tree/nut.js) [![Greenkeeper badge](https://badges.greenkeeper.io/nut-tree/nut.js.svg)](https://greenkeeper.io/) [![SonarCloud badge](https://sonarcloud.io/api/project_badges/measure?project=nut-tree%3Anut.js&metric=alert_status)](https://sonarcloud.io/dashboard?id=nut-tree%3Anut.js) [![SonarCloud Coverage](https://sonarcloud.io/api/project_badges/measure?project=nut-tree%3Anut.js&metric=coverage)](https://sonarcloud.io/component_measures?id=nut-tree%3Anut.js&metric=coverage)
22
<p align="center">
3-
Native UI testing / controlling with node.js
3+
Native UI testing / automation with node.js
44
</p>
55
<br/>
66
<p align="center">
7-
<a target="_blank" href="http://getrobot.net">
7+
<a target="_blank" href="https://robotjs.io/">
88
<img src="https://img.shields.io/badge/Built_with-ROBOT-C86414.svg?style=flat-square" alt="Built with Robot" />
99
</a>
1010
<a target="_blank" href="https://github.com/justadudewhohacks/opencv4nodejs">
@@ -55,6 +55,41 @@ describe("Basic test", () => {
5555

5656
```
5757

58+
# Installation
59+
60+
Running
61+
62+
```bash
63+
npm i @nut-tree/nut-js
64+
```
65+
66+
or
67+
68+
```bash
69+
yarn add @nut-tree/nut-js
70+
```
71+
72+
will install `nut.js` with its required dependencies.
73+
This will assume that you do not have an existing [OpenCV](https://opencv.org/) installation and will try to build `OpenCV` v3.4.3 from source (via `opencv4nodejs`).
74+
Building `OpenCV` from scratch requires a [cmake](https://cmake.org/) installation.
75+
76+
In case you already have an `OpenCV` installation (version 3.x.x required, e.g. via `brew install opencv@3`), you can disable the build process via environment variable:
77+
78+
```bash
79+
export OPENCV4NODEJS_DISABLE_AUTOBUILD=1
80+
```
81+
82+
or
83+
84+
```bash
85+
set OPENCV4NODEJS_DISABLE_AUTOBUILD=1
86+
```
87+
88+
Please make sure to also install all required peer dependencies:
89+
90+
- [opencv4nodejs](https://github.com/justadudewhohacks/opencv4nodejs#how-to-install)
91+
- [robotjs](http://robotjs.io/docs/building)
92+
5893
# Examples
5994

6095
[nut-tree/trailmix](https://github.com/nut-tree/trailmix) contains a set of ready to use examples which demo the usage ot nut.js.

0 commit comments

Comments
 (0)