diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..d2d488c --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,13 @@ +Android Gesture Detectors Framework Licence +=================================== + +Copyright (c) 2012, Almer Thie + +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index d9b55b8..821475d 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,56 @@ -Android Gesture Detectors Framework -=================================== - -Introduction ------------- - -Since I was amazed Android has a ScaleGestureDetector since API level 8 but -(still) no such thing as a RotateGestureDetector I decided to create this class -myself. In the process I decided to create a small extendable framework for -GestureDetectors in general. - -Tutorials ---------- - -### Using gesture detectors - -If you want to use the ScaleGestureDetector and/or the gesture detectors -from this project, please read my tutorial: [code.almeros.com/android-multitouch-gesture-detectors](http://code.almeros.com/android-multitouch-gesture-detectors) - -### Extending - -If you want to extend this framework with new gesture detectors please read -my tutorial about that here: *coming soon* - -I hope you'll send me a pull request with your FingerTwistGestureDetector or something ;) - -Containments ------------- - -### RotateGestureDetector - -Helps finding out the rotation angle between the line of two fingers (with the -normal or previous finger positions) - -### MoveGestureDetector - -Convenience gesture detector to keep it easy moving an object around with one -ore more fingers without losing the clean usage of the gesture detector pattern. - -### ScaleGestureDetector (default Android) - -This one is NOT in this framework, but is gesture detector that resides in the -Android API since API level 8 (2.2). - -### BaseGestureDetector (abstract) - -Abstract class that every new gesture detector class should extend. - -### TwoFingerGestureDetector (abstract) - -Abstract class that extends the BaseGestureDetector and that every new gesture -detector class for two finger operations should extend. +Android Gesture Detectors Framework +=================================== + +Introduction +------------ + +Since I was amazed Android has a ScaleGestureDetector since API level 8 but +(still) no such thing as a RotateGestureDetector I decided to create this class +myself. In the process I decided to create a small extendable framework for +GestureDetectors in general. + +Tutorials +--------- + +### Using gesture detectors + +If you want to use the ScaleGestureDetector and/or the gesture detectors +from this project, please read my tutorial: [code.almeros.com/android-multitouch-gesture-detectors](http://code.almeros.com/android-multitouch-gesture-detectors) + +### Extending + +If you want to extend this framework with new gesture detectors please read +my tutorial about that here: *coming soon* + +I hope you'll send me a pull request with your FingerTwistGestureDetector or something ;) + +Containments +------------ + +### RotateGestureDetector + +Helps finding out the rotation angle between the line of two fingers (with the +normal or previous finger positions) + +### MoveGestureDetector + +Convenience gesture detector to keep it easy moving an object around with one +ore more fingers without losing the clean usage of the gesture detector pattern. + +### ScaleGestureDetector (default Android) + +This one is NOT in this framework, but is gesture detector that resides in the +Android API since API level 8 (2.2). + +### BaseGestureDetector (abstract) + +Abstract class that every new gesture detector class should extend. + +### TwoFingerGestureDetector (abstract) + +Abstract class that extends the BaseGestureDetector and that every new gesture +detector class for two finger operations should extend. + +License +------------ +This prject is licensed with the 2-clause BSD license. \ No newline at end of file