diff options
| author | Přemysl Janouch <p.janouch@gmail.com> | 2014-10-28 03:24:08 +0100 |
|---|---|---|
| committer | Přemysl Janouch <p.janouch@gmail.com> | 2014-10-28 03:24:08 +0100 |
| commit | ef257d11fbf5207f3cf85c9f3c681be750d5e6e7 (patch) | |
| tree | 66d7fbe6d3c91b10559b4c2f26042b4186730fbc | |
| parent | 8838e88d913fe882f744b288a3cc280d14ca7c8b (diff) | |
| parent | f21f10ac1bdf92bb8bea366d8572e28d85185e82 (diff) | |
| download | neetdraw-ef257d11fbf5207f3cf85c9f3c681be750d5e6e7.tar.gz neetdraw-ef257d11fbf5207f3cf85c9f3c681be750d5e6e7.tar.xz neetdraw-ef257d11fbf5207f3cf85c9f3c681be750d5e6e7.zip | |
Merge pull request #1 from Bystroushaak/master
README rewritten to restructured text.
| -rw-r--r-- | README.rst (renamed from README) | 17 |
1 files changed, 10 insertions, 7 deletions
@@ -1,11 +1,11 @@ autistdraw ========== -`autistdraw' is a terminal drawing application with multiplayer support. +`autistdraw` is a terminal drawing application with multiplayer support. Building and Running -------------------- -Build dependencies: CMake, pkg-config, ncursesw, libev, termo (included) +Build dependencies: CMake, pkg-config, ncursesw, libev, termo (included):: $ git clone https://github.com/pjanouch/autistdraw.git $ git submodule init @@ -14,13 +14,16 @@ Build dependencies: CMake, pkg-config, ncursesw, libev, termo (included) $ cmake .. -DCMAKE_BUILD_TYPE=Debug $ make -Now, for standalone mode you can run: +Now, for standalone mode you can run:: + $ ./autistdraw -To run as a server for other clients to connect to and draw simultaneously: +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: +Finally, to connect to a running server, run:: + $ ./autistdraw -c localhost:1234 Usage @@ -35,14 +38,14 @@ 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. +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>. +`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 |