added vtunnel docs

TCPBridge/README.md

@@ -0,0 +1,55 @@
+# vTunnel - TCP-based Linked Card Emulator
+
+vTunnel can be used to add bridging over the internet to any existing OpenOS software that uses linked cards.
+
+Despite originally being written for Minitel, vTunnel implements a fully-functional linked card emulator and a server that will run under most unix-likes (OpenBSD is currently somewhat flaky, Linux is recommended).
+
+## Setup
+
+### Server
+
+#### Requirements
+
+- Some form of unix-like
+- Lua 5.2 or 5.3
+- Luasocket
+
+#### Running the server
+
+At present, all you need to do is run bridge.lua, for example:
+
+```
+lua53 bridge.lua
+```
+
+### Client
+
+#### OPPM
+
+```
+oppm install vtunnel
+```
+
+#### Manual
+1. Install vtunnel.lua to /usr/bin
+
+#### Starting
+
+vTunnel is invoked as follows:
+
+```
+vtunnel server_address server_port
+```
+
+This will create a virtual linked card component connected to server\_address:server\_port
+
+#### Minitel configuration
+
+1. Disable minitel with rc - `rc minitel disable`
+2. Add the following to your .shrc:
+
+```
+vtunnel server_address server_port
+rc minitel start
+```
+