added a README

1 files changed, 24 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..231ed57
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+overwiev
+========
+tcvt is an ANSI terminal emulator, that turns a `$COLUMNS` x `$LINES` terminal
+into a `$COLUMNS/2` x `$LINES*2` terminal. It ships the two commands `tcvt` and
+`optcvt` both of which are documented in the accompanying manual page.
+
+requriements
+============
+To run tcvt you need a Python 2.X where X is 6 or 7. Other than that only
+standard unix tools such as man, make, gzip, sed are needed.
+
+license
+=======
+tcvt is published under a 2-clause BSD license.
+
+installation
+============
+To install run `make install` optionally changing variables such as `$DESTDIR`
+or `$PREFIX`.
+
+feedback
+========
+Should you find bugs, missing features, missing documentation or have any other
+question, don't hesitate to contact me (`Helmut Grohne <helmut@subdivi.de>`).