From 0164a99cb337d579901bfee82e3f66accca21f84 Mon Sep 17 00:00:00 2001 From: Přemysl Janouch Date: Fri, 24 Oct 2014 23:01:11 +0200 Subject: Update the README --- README | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) (limited to 'README') diff --git a/README b/README index e981b0a..1cfe0ce 100644 --- a/README +++ b/README @@ -5,10 +5,7 @@ autistdraw Building and Running -------------------- -Build dependencies: GCC/Clang, pkg-config, GNU make, Jansson, cURL, readline - -If you don't have Clang, you can edit the Makefile to use GCC or TCC, they work -just as good. But there's no CMake support yet, so I force it in the Makefile. +Build dependencies: CMake, pkg-config, ncursesw, libuv, termo (included) $ git clone https://github.com/pjanouch/autistdraw.git $ git submodule init @@ -18,6 +15,18 @@ just as good. But there's no CMake support yet, so I force it in the Makefile. $ make $ ./autistdraw +Known Issues +------------ +VTE-based terminals, such as gnome-terminal, are terminally broken and you will +experience drawing artefacts. Those are neither a problem of this application, +nor a problem of ncurses as far as I can tell. + +To achieve the best results, please use a decent terminal such as rxvt-unicode +or xterm. These two are feature-full and _fast_. st also works great. + +Even so, try not to strain the application too much. It can and will break if +you flood the communication channel with the terminal. + License ------- `autistdraw' is written by Přemysl Janouch . -- cgit v1.2.3-70-g09d2