summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHelmut Grohne <helmut@subdivi.de>2021-01-22 19:53:44 +0100
committerHelmut Grohne <helmut@subdivi.de>2021-01-22 20:07:01 +0100
commitc3c892893d29a5ff265460219d75e980e777b381 (patch)
treeb1c578edc31e14758f1196afa9fc81771b7da024
parent7c7c6603c7f67a39d2b7d93dfe7f4f9c85d1c673 (diff)
downloadtcvt-c3c892893d29a5ff265460219d75e980e777b381.tar.gz
README.md: improve spelling and formatting
-rw-r--r--README.md26
1 files changed, 14 insertions, 12 deletions
diff --git a/README.md b/README.md
index eb6a795..473a8eb 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,27 @@
-overwiev
+Overview
========
-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.
+`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
+Requirements
============
-To run tcvt you need a Python 2.6, 2.7 or 3.3 or later, which is built against
-ncurses. A Python built against FreeBSD's curses is known to not work. Other
-than that only standard unix tools such as man, make, gzip, sed are needed.
+To run `tcvt` you need a Python 2.6, 2.7 or 3.3 or later, which is built
+against `ncurses`. A Python built against FreeBSD's `curses` is known to not
+work. Other than that only standard Unix tools such as `man`, `make`, `gzip`,
+`sed` are needed.
-license
+License
=======
-tcvt is published under a 2-clause BSD license.
+`tcvt` is published under a 2-clause BSD license.
-installation
+Installation
============
To install run `make install` optionally changing variables such as `$DESTDIR`
or `$PREFIX`.
-feedback
+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>`).