Update the README
This commit is contained in:
parent
98a5fcaac2
commit
0164a99cb3
17
README
17
README
|
@ -5,10 +5,7 @@ autistdraw
|
||||||
|
|
||||||
Building and Running
|
Building and Running
|
||||||
--------------------
|
--------------------
|
||||||
Build dependencies: GCC/Clang, pkg-config, GNU make, Jansson, cURL, readline
|
Build dependencies: CMake, pkg-config, ncursesw, libuv, termo (included)
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
$ git clone https://github.com/pjanouch/autistdraw.git
|
$ git clone https://github.com/pjanouch/autistdraw.git
|
||||||
$ git submodule init
|
$ 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
|
$ make
|
||||||
$ ./autistdraw
|
$ ./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
|
License
|
||||||
-------
|
-------
|
||||||
`autistdraw' is written by Přemysl Janouch <p.janouch@gmail.com>.
|
`autistdraw' is written by Přemysl Janouch <p.janouch@gmail.com>.
|
||||||
|
|
Loading…
Reference in New Issue