Skip to content

Commit

Permalink
Usage/install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ES-Alexander authored Feb 24, 2020
1 parent f6101e2 commit 82c2797
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,8 @@ _________________________________
_________________________________

Used to detect and analyse intersections (position and angle), find the distance between segments and from points to segments, and reduce a collection of lines by similarity. Intended for use in applications such as simplification of computer vision results (e.g. Hough Lines detected in an image), or in basic game development checking for polygon or bounding box intersections and/or proximity.

## Usage
Install via pip, using `python3 -m pip install --upgrade edgy-lines`.

To import Edge class, use `from edgy_lines.Edge2 import Edge`.

0 comments on commit 82c2797

Please sign in to comment.