aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2014-10-27 15:48:57 +0100
committerPřemysl Janouch <p.janouch@gmail.com>2014-10-27 15:48:57 +0100
commitac22d174917173fe6ebd0d6738e1605b9da8916b (patch)
treee1cae7e33c93b4b281b2039d359f43d02d551eda /README
parent1f2e4873027466248a041e9a06f0793213e9ff40 (diff)
downloadneetdraw-ac22d174917173fe6ebd0d6738e1605b9da8916b.tar.gz
neetdraw-ac22d174917173fe6ebd0d6738e1605b9da8916b.tar.xz
neetdraw-ac22d174917173fe6ebd0d6738e1605b9da8916b.zip
Update the README
Finally we're doing what we wanted.
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 14 insertions, 1 deletions
diff --git a/README b/README
index 84fc9ed..2ee09f8 100644
--- a/README
+++ b/README
@@ -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