From 74e10057f09c1b3893d7d37c2b4f8b4c765f73c4 Mon Sep 17 00:00:00 2001 From: Přemysl Janouch Date: Mon, 14 Mar 2016 21:11:01 +0100 Subject: Update README --- README.adoc | 54 +++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 43 insertions(+), 11 deletions(-) diff --git a/README.adoc b/README.adoc index 88dd471..42ee056 100644 --- a/README.adoc +++ b/README.adoc @@ -5,8 +5,17 @@ autistdraw image::http://www.image-share.com/upload/2848/201.png[screenshot] -Building and Running --------------------- +Packages +-------- +Regular releases are sporadic. git master should be stable enough. You can get +a package with the latest development version from Archlinux's AUR, or from +openSUSE Build Service for the rest of mainstream distributions. Consult the +list of repositories and their respective links at: + +https://build.opensuse.org/project/repositories/home:pjanouch:git + +Building +-------- Build dependencies: CMake, pkg-config, liberty (included), termo (included) + Runtime dependencies: ncursesw, libev @@ -16,22 +25,39 @@ Runtime dependencies: ncursesw, libev $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug $ make -Now, for standalone mode you can run: +To install the application, you can do either the usual: - $ ./autistdraw - -To run as a server for other clients to connect to and draw simultaneously: + # make install - $ ./autistdraw -s :1234 +Or you can try telling CMake to make a package for you. For Debian it is: -Finally, to connect to a running server, run: + $ cpack -G DEB + # dpkg -i autistdraw-*.deb - $ ./autistdraw -c localhost:1234 +Note that for versions of CMake before 2.8.9, you need to prefix `cpack` with +`fakeroot` or file ownership will end up wrong. 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. +For standalone mode you can run the program without arguments: + + $ autistdraw + +To run as a server for other clients to connect to and draw simultaneously: + + $ autistdraw -s :1234 + +To connect to a running server, run: + + $ autistdraw -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 +button to move the canvas. + +You can store the current image to `drawing.bin` and load it back using the +'s' and 'l' keys respectively. To just export the current picture for printing +it on a terminal, press 'e'. To export for IRC, press 'E'. Known Issues ------------ @@ -45,6 +71,12 @@ 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. +Contributing and Support +------------------------ +Use this project's GitHub to report any bugs, request features, or submit pull +requests. If you want to discuss this project, or maybe just hang out with +the developer, feel free to join me at irc://irc.janouch.name, channel #dev. + License ------- 'autistdraw' is written by Přemysl Janouch . -- cgit v1.2.3-70-g09d2