From 9bb7cc8e2d9029f12d49252d19de272a682ba02f Mon Sep 17 00:00:00 2001
From: Sebastian Oliva <code@sebastianoliva.com>
Date: Thu, 2 Jul 2015 13:28:02 -0600
Subject: [PATCH] Create README.md

---
 README.md | 113 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 113 insertions(+), 0 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..252d3bb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,113 @@
+
+# tty0tty - linux null modem emulator v1.2 
+
+
+The tty0tty directory tree is divided in:
+
+  **module** - linux kernel module null-modem  
+  **pts** - null-modem using ptys (without handshake lines)
+
+
+## Null modem pts (unix98): 
+
+  When run connect two pseudo-ttys and show the connection names:
+  
+  (/dev/pts/1) <=> (/dev/pts/2)  
+
+  the connection is:
+  
+  TX -> RX  
+  RX <- TX  
+
+
+
+## Module:
+
+ The module is tested in kernel 3.10.2 (debian) 
+
+  When loaded, create 8 ttys interconnected:
+  
+  /dev/tnt0  <=>  /dev/tnt1  
+  /dev/tnt2  <=>  /dev/tnt3  
+  /dev/tnt4  <=>  /dev/tnt5  
+  /dev/tnt6  <=>  /dev/tnt7  
+
+  the connection is:
+  
+  TX   ->  RX  
+  RX   <-  TX  
+  RTS  ->  CTS  
+  CTS  <-  RTS  
+  DSR  <-  DTR  
+  CD   <-  DTR  
+  DTR  ->  DSR  
+  DTR  ->  CD  
+  
+
+## Requirements:
+
+  For building the module kernel-headers or kernel source are necessary.
+
+## Installation:
+
+Download the tty0tty package from one of these sources:
+Clone the repo https://github.com/freemed/tty0tty
+
+```
+git clone https://github.com/freemed/tty0tty
+```
+
+Extract it
+
+```
+tar xf tty0tty-1.2.tgz
+```
+
+Build the kernel module from provided source
+
+```
+cd tty0tty-1.2/module
+make
+```
+
+Copy the new kernel module into the kernel modules directory
+
+```
+sudo cp tty0tty.ko /lib/modules/$(uname -r)/kernel/drivers/misc/
+```
+
+Load the module
+
+```
+sudo depmod
+sudo modprobe tty0tty
+```
+
+You should see new serial ports in ```/dev/``` (```ls /dev/tnt*```)
+Give appropriate permissions to the new serial ports
+
+```
+sudo chmod 666 /dev/tnt*
+```
+
+You can now access the serial ports as /dev/tnt0 (1,2,3,4 etc) Note that the consecutive ports are interconnected. For example, /dev/tnt0 and /dev/tnt1 are connected as if using a direct cable.
+
+Persisting across boot:
+
+edit the file /etc/modules (Debian) or /etc/modules.conf
+
+```
+nano /etc/modules
+```
+and add the following line:
+
+```
+tty0tty
+```
+
+Note that this method will not make the module persist over kernel updates so if you ever update your kernel, make sure you build tty0tty again repeat the process.
+
+
+## Contact
+
+For e-mail suggestions :  lcgamboa@yahoo.com
--
libgit2 0.21.4