Skip to content

Commit

Permalink
Minor style update to doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
sam-drew committed Nov 16, 2018
1 parent 7e53275 commit 771daab
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/picket.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@

picket is a library that uses coordinate geometry to calculate whether a given point is inside a fence made from several other points. It treats the latitude/longitude system as a coordinate grid to do this, with North & East as positive axes and South & West as negative axes. Points must be provided in decimal lat/long form, but a conversion method is available for values in Degrees, Minutes, and Seconds (DMS).

## How it works.
## The Maths.

picket uses various pieces of coordinate geometry maths to perform its calculations. This is probably best explained using a worked example.

Point to be checked (P) = `(3, 2)`.
Points that form the fence (in order) (ABCD) = `[(-2, 3), (4, 4), (3, -2), (-1, -1)]`.

![Figure 1](fig_1/figure_1.png)

*Figure 1*

As you can see in *Figure 1*, the fence is shown in blue and the point to be checked in shown in red. The point is clearly within the fence, but for a computer it's not quite that easy.
Expand Down

0 comments on commit 771daab

Please sign in to comment.