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

Merge pull request #1 from Bystroushaak/master 

README rewritten to restructured text.
This commit is contained in:
Přemysl Eric Janouch 2014-10-28 03:24:08 +01:00
parent 8838e88d91 f21f10ac1b
commit ef257d11fb
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README → README.rst
View File

@ -1,11 +1,11 @@
autistdraw autistdraw
========== ==========
`autistdraw' is a terminal drawing application with multiplayer support. `autistdraw` is a terminal drawing application with multiplayer support.
Building and Running Building and Running
-------------------- --------------------
Build dependencies: CMake, pkg-config, ncursesw, libev, termo (included) Build dependencies: CMake, pkg-config, ncursesw, libev, termo (included)::
$ git clone https://github.com/pjanouch/autistdraw.git $ git clone https://github.com/pjanouch/autistdraw.git
$ git submodule init $ git submodule init
@ -14,13 +14,16 @@ Build dependencies: CMake, pkg-config, ncursesw, libev, termo (included)
$ cmake .. -DCMAKE_BUILD_TYPE=Debug $ cmake .. -DCMAKE_BUILD_TYPE=Debug
$ make $ make
Now, for standalone mode you can run: Now, for standalone mode you can run::
$ ./autistdraw $ ./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 $ ./autistdraw -s :1234
Finally, to connect to a running server, run: Finally, to connect to a running server, run::
$ ./autistdraw -c localhost:1234 $ ./autistdraw -c localhost:1234
Usage Usage
@ -35,14 +38,14 @@ experience drawing artefacts. Those are neither a problem of this application,
nor a problem of ncurses as far as I can tell. 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 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 Even so, try not to strain the application too much. It can and will break if
you flood the communication channel with the terminal. 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>.
You may use the software under the terms of the ISC license, the text of which 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 is included within the package, or, at your option, you may relicense the work