From ac22d174917173fe6ebd0d6738e1605b9da8916b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emysl=20Janouch?= Date: Mon, 27 Oct 2014 15:48:57 +0100 Subject: Update the README Finally we're doing what we wanted. --- README | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) 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 -- cgit v1.2.3