summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2016-02-16 11:53:28 +0100
committerMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2016-02-16 11:53:28 +0100
commitf431158ae2412ed23bd4d2336af00d2b5c170d31 (patch)
tree52c5fbbc7ba26f7444edbe7d0e8d80ed67796384 /README.md
downloaduca-net-f431158ae2412ed23bd4d2336af00d2b5c170d31.tar.gz
uca-net-f431158ae2412ed23bd4d2336af00d2b5c170d31.tar.bz2
uca-net-f431158ae2412ed23bd4d2336af00d2b5c170d31.tar.xz
uca-net-f431158ae2412ed23bd4d2336af00d2b5c170d31.zip
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2352ac1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+## uca-net
+
+A transparent TCP-based network bridge camera for remote access of libuca
+cameras.
+
+### Installation and usage
+
+The only dependency is libuca itself and any camera you wish to access. Build
+the server and client with
+
+ $ mkdir build && cd build
+ $ cmake ..
+ $ make && (sudo) make install
+
+Now, you can start a server on a remote machine with
+
+ $ ucad mock
+
+and connect to it from any other machine, e.g.
+
+ $ uca-grab -n 10 net # grab ten frames
+ $ uca-camera-control -c net # control graphically