aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorPřemysl Eric Janouch <p@janouch.name>2021-11-16 11:50:48 +0100
committerPřemysl Eric Janouch <p@janouch.name>2021-11-16 11:52:54 +0100
commit023d69bdbfa41bdfbd624b58fd2f30dd3cf1a625 (patch)
tree6c277e7803b010a686b60ab0667847cebfa4a45c /README.adoc
parent3959693f798efbba53593102e28a3fd00146ed6f (diff)
downloadneetdraw-023d69bdbfa41bdfbd624b58fd2f30dd3cf1a625.tar.gz
neetdraw-023d69bdbfa41bdfbd624b58fd2f30dd3cf1a625.tar.xz
neetdraw-023d69bdbfa41bdfbd624b58fd2f30dd3cf1a625.zip
Rename the project
The old name had its context, but now it's mostly just confusing. Make it netdraw with an extra 'e'.
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc24
1 files changed, 12 insertions, 12 deletions
diff --git a/README.adoc b/README.adoc
index f438ab3..a30ffcf 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,9 +1,9 @@
-autistdraw
-==========
+neetdraw
+========
-'autistdraw' is a terminal drawing application with multiplayer support.
+'neetdraw' is a terminal drawing application with multiplayer support.
-image::autistdraw.png[align="center"]
+image::neetdraw.png[align="center"]
Packages
--------
@@ -15,9 +15,9 @@ Building
Build dependencies: CMake, pkg-config, liberty (included), termo (included) +
Runtime dependencies: ncursesw, libev
- $ git clone --recursive https://git.janouch.name/p/autistdraw.git
- $ mkdir autistdraw/build
- $ cd autistdraw/build
+ $ git clone --recursive https://git.janouch.name/p/neetdraw.git
+ $ mkdir neetdraw/build
+ $ cd neetdraw/build
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
$ make
@@ -28,21 +28,21 @@ To install the application, you can do either the usual:
Or you can try telling CMake to make a package for you. For Debian it is:
$ cpack -G DEB
- # dpkg -i autistdraw-*.deb
+ # dpkg -i neetdraw-*.deb
Usage
-----
For standalone mode you can run the program without arguments:
- $ autistdraw
+ $ neetdraw
To run as a server for other clients to connect to and draw simultaneously:
- $ autistdraw -s :1234
+ $ neetdraw -s :1234
To connect to a running server, run:
- $ autistdraw -c localhost:1234
+ $ neetdraw -c localhost:1234
Once you have the program running, simply select a colour you like from the
palette and draw by pressing and dragging the mouse. Use the middle mouse
@@ -66,7 +66,7 @@ you flood the communication channel with the terminal.
Contributing and Support
------------------------
-Use https://git.janouch.name/p/autistdraw to report any bugs, request features,
+Use https://git.janouch.name/p/neetdraw to report any bugs, request features,
or submit pull requests. `git send-email` is tolerated. If you want to discuss
the project, feel free to join me at ircs://irc.janouch.name, channel #dev.