Update the README

Finally we're doing what we wanted.
This commit is contained in:
Přemysl Eric Janouch 2014-10-27 15:48:57 +01:00
parent 1f2e487302
commit ac22d17491
1 changed files with 14 additions and 1 deletions

15
README
View File

@ -1,7 +1,7 @@
autistdraw
==========
`autistdraw' will be a terminal drawing application with multiplayer support.
`autistdraw' is a terminal drawing application with multiplayer support.
Building and Running
--------------------
@ -13,8 +13,21 @@ Build dependencies: CMake, pkg-config, ncursesw, libuv>=0.11.x, termo (included)
$ mkdir build
$ cmake .. -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