aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f0ba6a6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+Movement detection application.
+Once movement is detected, application starts streaming via router to one of available servers.
+Server stores video stream and makes them avaiable via a web gui, also live.
+
+This repo includes only the application layer.
+Although this is written for Gentoo Linux, it should be trivial to run on any other nix.
+
+There shall be another git repo for the OS bits necessary for deployment.
+
+Technologies used:
+
+- Gentoo Linux;
+- V4l for handling of camera stream;
+- OpenCV (Python bindings) for movement detection;
+- ZeroMQ (Python bindings) for messaging;
+- FastAPI for web part.
+
+
+Necessary Gentoo packages (may not be complete):
+
+media-libs/opencv[python,v4l] - USE list may be incomplete
+net-libs/zeromq[drafts, sodium]
+
+Necessary python modules (may not be complete):
+dev-python/inotify