Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Meakk committed Dec 11, 2015
1 parent 2b88d35 commit e3103cd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ A JavaScript library for fast circle fitting of a set of 2D points.
The implementation is based on a Least-Squares method to find the 3 unknowns : x and y coordinates and the radius.

# Speed and stability
The algorithm do not contain any iterative solvers and will find a solution in linear time, meaning that you will have the result instantly.
The algorithm do not contain any iterative solvers and will find a solution in linear time, meaning that you will have the result instantly.
This library handles degenerate cases when you do not have enough non-colinear points to determine a correct circle by returning an error flag.

# Getting started
The library is simple to use. Include it to define a global object `CIRCLEFIT`.
The library is simple to use. Include `circlefit.js`, the global object `CIRCLEFIT` is automatically created.
This object have 3 methods :
* `addPoint(x, y)` : add a point to the set
* `clearPoints()` : remove all points
Expand Down

0 comments on commit e3103cd

Please sign in to comment.