Skip to content

Commit 74fa5ef

Browse files
authored
Added Note on Docker Usage
No mention was yet made regarding the installation errors that may occur if a user attempts to install opencv4nodejs onto the Docker image, so I propose adding a small change to notify users of the likelihood of said errors and two workarounds.
1 parent a7d96ae commit 74fa5ef

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,8 @@ Or simply pull from [justadudewhohacks/opencv-nodejs](https://hub.docker.com/r/j
141141
FROM justadudewhohacks/opencv-nodejs
142142
```
143143

144+
**Note**: The aforementioned Docker image does not have build tools installed. In order to prevent errors during an ```npm install```, you can either install opencv4nodejs globally and link to it in your project or install production packages only in your Dockerfile.
145+
144146
Different OpenCV 3.x base images can be found here: https://hub.docker.com/r/justadudewhohacks/.
145147

146148
<a name="usage-with-electron"></a>
@@ -502,4 +504,4 @@ const cv = require('opencv4nodejs')
502504
* <a href="https://justadudewhohacks.github.io/opencv4nodejs/docs/SIFTDetector#SIFTDetector"><b>xfeatures2d</b></a>
503505
* <a href="https://justadudewhohacks.github.io/opencv4nodejs/docs/MultiTracker#MultiTracker"><b>tracking</b></a>
504506
* <a href="https://justadudewhohacks.github.io/opencv4nodejs/docs/OCRHMMClassifier#OCRHMMClassifier"><b>text</b></a>
505-
* <a href="https://justadudewhohacks.github.io/opencv4nodejs/docs/EigenFaceRecognizer#EigenFaceRecognizer"><b>face</b></a>
507+
* <a href="https://justadudewhohacks.github.io/opencv4nodejs/docs/EigenFaceRecognizer#EigenFaceRecognizer"><b>face</b></a>

0 commit comments

Comments
 (0)