diff options
| -rw-r--r-- | README.md | 26 |
1 files changed, 14 insertions, 12 deletions
@@ -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>`). |