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

Convert README to AsciiDoc

This commit is contained in:
Přemysl Eric Janouch 2015-09-27 02:08:32 +02:00
parent e2bc6b0263
commit c31966b0c4
1 changed files with 12 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.rst → README.adoc
View File

@ -1,34 +1,30 @@
autistdraw
==========
`autistdraw` is a terminal drawing application with multiplayer support.
'autistdraw' is a terminal drawing application with multiplayer support.
.. image:: http://www.image-share.com/upload/2848/201.png
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
Build dependencies: CMake, pkg-config, liberty (included), termo (included) +
Runtime dependencies: ncursesw, libev
::
$ git clone https://github.com/pjanouch/autistdraw.git
$ git submodule init
$ git submodule update
$ mkdir build
$ cd build
$ 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::
Now, for standalone mode you can run:
$ ./autistdraw
To run as a server for other clients to connect to and draw simultaneously::
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::
Finally, to connect to a running server, run:
$ ./autistdraw -c localhost:1234
@ -44,14 +40,14 @@ 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.
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>.
'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