p
/
neetdraw
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update the README

This commit is contained in:
Přemysl Eric Janouch 2014-10-24 23:01:11 +02:00
parent 98a5fcaac2
commit 0164a99cb3
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README
View File

@ -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>.