From: Michal Sojka <michal.sojka@cvut.cz>
Date: Wed, 25 Nov 2020 08:14:37 +0000 (+0100)
Subject: Add README
X-Git-Url: https://rtime.felk.cvut.cz/gitweb/sojka/sterm.git/commitdiff_plain/3e1528e06bcddd7290103fe2ad070d51c65fdad7

Add README
---

diff --git a/README.md b/README.md
new file mode 100644
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