]> rtime.felk.cvut.cz Git - sojka/sterm.git/commitdiff
Add README
authorMichal Sojka <michal.sojka@cvut.cz>
Wed, 25 Nov 2020 08:14:37 +0000 (09:14 +0100)
committerMichal Sojka <michal.sojka@cvut.cz>
Wed, 25 Nov 2020 08:14:37 +0000 (09:14 +0100)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..caf5654
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Simple serial terminal
+
+This is a minimalist terminal program like *minicom* or *cu*. The only
+thing it does is creating a bidirectional connection between
+stdin/stdout and a terminal device (e.g. serial line). It can also set
+serial line baudrate, manipulate DTR/RTS modem lines, send break and
+throttle transmission speed.
+
+The `-d` and `-r` option create short pulse on DTR/RTS. Linux always
+raises these lines when the device is opened and those options lower
+the lines immediately after opening.
+
+For more details see the [man page](./sterm.man).
+
+## Installation
+
+    make
+       make install