aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2014-10-24 23:01:11 +0200
committerPřemysl Janouch <p.janouch@gmail.com>2014-10-25 00:03:17 +0200
commit0164a99cb337d579901bfee82e3f66accca21f84 (patch)
tree4f2d07c36827525d14c8c4084e20f635f5fd6700
parent98a5fcaac2ee51ff3966cd1956c8bcbca7267033 (diff)
downloadneetdraw-0164a99cb337d579901bfee82e3f66accca21f84.tar.gz
neetdraw-0164a99cb337d579901bfee82e3f66accca21f84.tar.xz
neetdraw-0164a99cb337d579901bfee82e3f66accca21f84.zip
Update the README
-rw-r--r--README17
1 files changed, 13 insertions, 4 deletions
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 <p.janouch@gmail.com>.