diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..09f8f09 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,22 @@ + +Author: Richard Hirner + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..0b4c995 --- /dev/null +++ b/README.md @@ -0,0 +1,120 @@ + +To be informed about updates: + +* [follow GfxTablet on Twitter](http://twitter.com/GfxTablet) +* [subscribe to our RSS/Atom feed](http://feeds.feedburner.com/GfxTablet) +* [subscribe to email notifications](http://feedburner.google.com/fb/a/mailverify?uri=GfxTablet) + + +What is GfxTablet? +================== + +GfxTablet shall make it possible to use your Android device (especially +tablets) like a graphics tablet. + +It consists of two components: + +* the GfxTablet Android app +* the input driver for your PC + +The GfxTablet app sends motion and touch events via UDP to a specified host +on port 40117. + +The input driver must be installed on your PC. It creates a virtual "network tablet" +on your PC that is controlled by your Android device. + +So, you can use your Android tablet or smartphone to control the PC and, +for instance _use GIMP with your Android tablet as a graphics tablet_ +(even pressure-sensitive, if your hardware supports it). + +Homepage: http://rfc2822.github.com/GfxTablet/ + +If you want to support this project, please consider a [donation via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=ZT8F5NRCBDB2C&no_note=0&no_shipping=1¤cy_code=EUR&item_name=GfxTablet+donation). + + +License +------- + +GfxTablet is licensed under The MIT License. + +Author: Richard Hirner + +Powered by [bitfire web engineering](http://www.bitfire.at) / [gimpusers.com](http://www.gimpusers.com) + + +Features +-------- + +* Pressure sensitivity supported +* Size of canvas will be detected and sent to the client +* Option for ignoring events that are not triggered by a stylus pen: + so you can lay your hand on the tablet and draw with the pen. + + +Requirements +------------ + +* App: Any device with Android 4.0+ and touch screen +* Driver: Linux with uinput kernel module (included in modern versions of Fedora, Ubuntu etc.) + + +Installation +============ + +Github repository: http://github.com/rfc2822/GfxTablet + + +Part 1: uinput driver +--------------------- + +On your PC, either download one of these binaries (don't forget to `chmod a+x` it): + +* [uinput-networktablet 64-bit, dynamically linked, tested with Fedora 18 and Ubuntu 12.10](https://github.com/rfc2822/GfxTablet/blob/binaries/uinput-networktablet-x86_64?raw=true) + +or compile it yourself (don't be afraid, it's only one file) + +1. Clone the repository: + `git clone git://github.com/rfc2822/GfxTablet.git` +2. Install gcc, make and linux kernel header includes (`kernel-headers` on Fedora) +3. `cd driver-uinput; make` + +Then, run the binary. The driver runs in user-mode, so it doesn't need any special privileges. +However, it needs access to `/dev/uinput`. If your distribution doesn't create a group for +uinput access, you'll need to do it yourself or just run the driver as root: + +`sudo ./networktablet` + +Then, `xinput list` should show a "Network Tablet" device. + +You can start and stop (Ctrl+C) the Network Tablet at any time, but please be aware that applications +which use the device may be confused by that and could crash. + +`networktablet` will display a dot for every touch/motion event it receives. + + +Part 2: App +----------- + +You can either compile the app from the source code in the Git repository or download +it directly from Google Play: https://play.google.com/store/apps/details?id=at.bitfire.gfxtablet + +After installing, enter your host IP in the Settings / Host name and it should be ready. + + +Part 3: Use it +-------------- + +Now you can use your tablet as an input device in every Linux application (including X.org +applications). For instance, when networktablet is running, GIMP should have a "Network Tablet" +entry in "Edit / Input Devices". Set its mode to "Screen" and it's ready to use. + +It's important that you start the app *after* the driver, because it sends the resolution +to the driver. If you start the app before the driver, the mouse cursor will always be on +the left top and won't move much. + + +Support +======= + +For bug reports, please use the [Github issues page](https://github.com/rfc2822/GfxTablet/issues) +or just fork the repository, fix the bug and send a merge request. diff --git a/app-android/README.md b/app-android/README.md deleted file mode 100644 index 787a74c..0000000 --- a/app-android/README.md +++ /dev/null @@ -1,43 +0,0 @@ - -XorgTablet -========== - -XorgTablet is an Android app that sends motion and touch events -via UDP to a specified host on port 40117. - -It is especially useful in combination with the xf86-networktablet -X.org input driver (https://github.com/rfc2822/xf86-networktablet) -that allows these touch events to be processed by the X server. So, -you can use your Android tablet or smartphone to control the X -server and, for instance *use GIMP with your Android tablet -as a graphics tablet* (even pressure-sensitive, if your hardware -supports it). - - -Requirements ------------- - -Any device with Android 4.0+ and touch screen - - -Download --------- - -You can find the latest binary on SourceForge: -https://sourceforge.net/projects/xorgtablet/files/XorgTablet/ - - -Features --------- - -* Pressure sensitive -* Size of canvas will be detected and sent to the client -* Option for ignoring events that are not triggered by a stylus pen: - so you can lay your hand on the tablet and draw with the pen. - - -Technical details ------------------ - -The used protocol: -https://github.com/rfc2822/xf86-networktablet/blob/master/protocol.h