aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBystroushaak <bystrousak@kitakitsune.org>2014-10-28 03:17:39 +0100
committerBystroushaak <bystrousak@kitakitsune.org>2014-10-28 03:17:39 +0100
commitf21f10ac1bdf92bb8bea366d8572e28d85185e82 (patch)
tree66d7fbe6d3c91b10559b4c2f26042b4186730fbc /README
parent8838e88d913fe882f744b288a3cc280d14ca7c8b (diff)
downloadneetdraw-f21f10ac1bdf92bb8bea366d8572e28d85185e82.tar.gz
neetdraw-f21f10ac1bdf92bb8bea366d8572e28d85185e82.tar.xz
neetdraw-f21f10ac1bdf92bb8bea366d8572e28d85185e82.zip
README rewritten to restructured text.
Diffstat (limited to 'README')
-rw-r--r--README51
1 files changed, 0 insertions, 51 deletions
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 <p.janouch@gmail.com>.
-
-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