From f21f10ac1bdf92bb8bea366d8572e28d85185e82 Mon Sep 17 00:00:00 2001 From: Bystroushaak Date: Tue, 28 Oct 2014 03:17:39 +0100 Subject: README rewritten to restructured text. --- README | 51 --------------------------------------------------- 1 file changed, 51 deletions(-) delete mode 100644 README (limited to 'README') diff --git a/README b/README deleted file mode 100644 index c1956aa..0000000 --- a/README +++ /dev/null @@ -1,51 +0,0 @@ -autistdraw -========== - -`autistdraw' is a terminal drawing application with multiplayer support. - -Building and Running --------------------- -Build dependencies: CMake, pkg-config, ncursesw, libev, termo (included) - - $ git clone https://github.com/pjanouch/autistdraw.git - $ git submodule init - $ git submodule update - $ 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 -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. - -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 . - -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 -under the MIT or the Modified BSD License, as listed at the following site: - -http://www.gnu.org/licenses/license-list.html -- cgit v1.2.3-54-g00ecf