diff options
| author | Přemysl Janouch <p.janouch@gmail.com> | 2015-09-27 02:08:32 +0200 |
|---|---|---|
| committer | Přemysl Janouch <p.janouch@gmail.com> | 2015-09-27 02:08:32 +0200 |
| commit | c31966b0c47cf539d1459d131eac6044f78269a6 (patch) | |
| tree | dc7828ced66ac69ebc027afd1b0bcce312c4bd69 /README.adoc | |
| parent | e2bc6b026305807c92f57251618dc7d30dd416f6 (diff) | |
| download | neetdraw-c31966b0c47cf539d1459d131eac6044f78269a6.tar.gz neetdraw-c31966b0c47cf539d1459d131eac6044f78269a6.tar.xz neetdraw-c31966b0c47cf539d1459d131eac6044f78269a6.zip | |
Convert README to AsciiDoc
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..88dd471 --- /dev/null +++ b/README.adoc @@ -0,0 +1,56 @@ +autistdraw +========== + +'autistdraw' is a terminal drawing application with multiplayer support. + +image::http://www.image-share.com/upload/2848/201.png[screenshot] + +Building and Running +-------------------- +Build dependencies: CMake, pkg-config, liberty (included), termo (included) + +Runtime dependencies: ncursesw, libev + + $ git clone --recursive https://github.com/pjanouch/autistdraw.git + $ mkdir autistdraw/build + $ cd autistdraw/build + $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug + $ make + +Now, for standalone mode you can run: + + $ ./autistdraw + +To run as a server for other clients to connect to and draw simultaneously: + + $ ./autistdraw -s :1234 + +Finally, to connect to a running server, run: + + $ ./autistdraw -c localhost:1234 + +Usage +----- +Simply select a colour you like from the palette and draw by clicking and +dragging the mouse. Use the middle mouse button to move the canvas. + +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>. + +You may use the software under the terms of the ISC license, the text of which +is included within the package, or, at your option, you may relicense the work +under the MIT or the Modified BSD License, as listed at the following site: + +http://www.gnu.org/licenses/license-list.html |