summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorpommicket <leonardomtenenbaum@gmail.com>2016-03-17 15:40:51 -0400
committerpommicket <leonardomtenenbaum@gmail.com>2016-03-17 15:40:51 -0400
commite308244bd1a8ade75479a454006ee10d7ff0d634 (patch)
tree97e55e6b44d9389027de08c2b2fb12198e482681 /README.md
parent8920a6b89c38ff2e7caafe0a3b2146b44927ba07 (diff)
Added installation and instructions to readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 619ff9f..4942622 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,23 @@
A program that takes a video from your webcam, puts it through a random function, then shows the resulting video.
This program is like [AutoArt](http://github.com/pommicket/AutoArt), but it takes a video from your webcam and turns it into AutoArt.
+
+AutoCam requires:
+ - Python
+ - OpenCV
+ - Numpy
+
+On Ubuntu/Debian, these can be installed using:
+```bash
+sudo apt-get install python python-opencv python-numpy
+```
+
+On other platforms, you can use pip to install the dependencies.
+
+To run AutoCam:
+```bash
+cd the/directory/where/AutoCam/is
+python rgbautocam.py
+```
+
+You can replace rgbautocam with autocam if you want the R, G, and B functions to be the same.