Readme, Licence etc.

This commit is contained in:
hkrish 2013-04-22 16:18:44 +02:00
parent eec2638146
commit 282b19b6bc
3 changed files with 41 additions and 0 deletions

1
.gitignore vendored Normal file
View file

@ -0,0 +1 @@
tags

9
COPYING Normal file
View file

@ -0,0 +1,9 @@
The MIT License (MIT)
Copyright (c) 2013 Harikrishnan Gopalakrishnan
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.

31
README.md Normal file
View file

@ -0,0 +1,31 @@
Vector boolean operations on paperjs objects.
This is mostly written for clarity (I hope it is clear) and compatibility,
not optimised for performance, and has to be tested heavily for stability.
(Looking up to Java's Area path boolean algorithms for stability,
but the code is too complex —mainly because the operations are stored and
enumerable, such as quadraticCurveTo, cubicCurveTo etc.; and is largely
undocumented to directly adapt from)
Supported
- paperjs Path and CompoundPath objects
- Boolean Union
- Boolean Intersection
- Boolean Subtraction
- Resolving a self-intersecting Path
Not supported yet ( which I would like to see supported )
- Boolean operations between self-intersecting Paths
- Paths are clones of each other that ovelap exactly on top of each other!
This is meant to be integrated into the paperjs library in the near future.
------
Harikrishnan Gopalakrishnan
http://hkrish.com/playground/paperjs/booleanStudy.html
------
Paperjs
Copyright (c) 2011, Juerg Lehni & Jonathan Puckey
http://paperjs.org/license/