summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSrikant Patnaik2016-06-09 14:59:17 +0530
committerSrikant Patnaik2016-06-09 14:59:17 +0530
commitf42366cc0d2a21cdc21e7ae5c132229d79b4d5cc (patch)
tree4b01a29a5b204062fd70222927ab9489be73db78
parentccadcf397c0e1c3a79a84a3b7e45b8ac2647b336 (diff)
downloadtuxviewer-f42366cc0d2a21cdc21e7ae5c132229d79b4d5cc.tar.gz
tuxviewer-f42366cc0d2a21cdc21e7ae5c132229d79b4d5cc.tar.bz2
tuxviewer-f42366cc0d2a21cdc21e7ae5c132229d79b4d5cc.zip
a more precise readmeHEADmaster
-rw-r--r--README.rst25
1 files changed, 8 insertions, 17 deletions
diff --git a/README.rst b/README.rst
index d1af866..5a5c3f1 100644
--- a/README.rst
+++ b/README.rst
@@ -1,32 +1,23 @@
README
======
-A simple server based remote desktop viewer.
+A wrapper program to share your GNU/Linux desktop over the internet with
+authentication.
Requirements
------------
-* VNC viewer and server
+Assuming `host-1` wish to share the desktop with `host-2`.
-* x11vnc
+* VNC viewer (host-1)
-* ssh server and client
+* x11vnc (host-2)
-* zenity
+* ssh server and client (for port forwarding, on both host-1 and host-2)
-* web server
+* A desktop UI (for both
-
-Working
--------
-
-There will be one dialog based application for both client(one who wish to
-share desktop) and techie(who will access client's machine).
-
-* Client when opens the application will be provided with an ID and password,
- to be shared with techie.
-
-* Upon feeding the credentials techie can view the client's desktop
+* http server to manage ports (on a 3rd computer which is accessible from all hosts)