From 48b868c5208816b007ec1d9c7940e75b4c64e5ce Mon Sep 17 00:00:00 2001
From: MariaMatveeva <matveeva.maria@gmail.com>
Date: Fri, 26 Aug 2016 14:29:03 +0200
Subject: Update documentation

---
 docs/uca-net.rst | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 docs/uca-net.rst

(limited to 'docs/uca-net.rst')

diff --git a/docs/uca-net.rst b/docs/uca-net.rst
new file mode 100644
index 0000000..7a71608
--- /dev/null
+++ b/docs/uca-net.rst
@@ -0,0 +1,42 @@
+TCP-based network bridge camera
+===============================
+
+`uca-net`_ is a transparent TCP-based network bridge camera for remote access of ``libuca``
+cameras.
+
+.. _uca-net: https://github.com/ufo-kit/uca-net
+
+
+Installation
+------------
+
+The only dependency is libuca itself and any camera you wish to access.
+
+Clone the repository::
+
+    $ git clone https://github.com/ufo-kit/uca-net.git
+
+and create a new build directory inside::
+
+    $ cd uca-net/
+    $ mkdir build
+
+The installation process is the same as by ``libuca``::
+
+    $ cd build/
+    $ cmake ..
+    $ make
+    $ sudo make install
+
+
+Usage
+-----
+
+You can start a server on a remote machine with::
+
+    $ ucad camera-model
+
+and connect to it from any other machine, for example::
+
+    $ uca-grab -p host=foo.bar.com:4567 -n 10 net   // grab ten frames
+    $ uca-camera-control -c net                     // control graphically
-- 
cgit v1.2.3