From d3c44110062cb14f2085c637319ad4b5ce137e64 Mon Sep 17 00:00:00 2001 From: Apurv Kiri Date: Fri, 14 Nov 2014 13:22:46 +0530 Subject: [PATCH] Updated Readme --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6ab1616..7ebbeb0 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,16 @@ Access and stream web cam in nodejs using opencv and web sockets. -#### Usage +#### Building + +- It required opencv headers and library to build and run. +- Modify `include_dirs` for headers path and `library_dirs` for library path in `binding.gyp` according to your opencv installation. +- Then build with `node-gyp build` + +#### Running ``` -npm start -- [-open] [-wsport websocketPort] [-webport webserverport] [-ip ipaddress/domain] +npm start -- [-open] [-wsport websocketPort] [-webport webserverport] [-ip ipaddress/domain] [-res widthxheight] ``` | Option | Description | @@ -14,3 +20,4 @@ npm start -- [-open] [-wsport websocketPort] [-webport webserverport] [-ip ipadd |-wsport | Web socket port for streaming media | |-webport | Web server port | |-ip | Domain name/ip for non-localhost clients | +|-res | Resolution for preview image | \ No newline at end of file