Skip to content

Commit

Permalink
Describe how to navigate docs (#165)
Browse files Browse the repository at this point in the history
  • Loading branch information
asinghvi17 authored Jun 24, 2024
1 parent 1e46749 commit 14ab5c8
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,15 @@ GeometryOps tries to offer most of the basic geometry operations you'd need, imp

See the "API" page in the docs for a more complete list!

## How to navigate the docs

GeometryOps' [docs](https://juliageo.org/GeometryOps.jl/stable) are divided into three main sections: tutorials, explanations and source code.
Documentation and examples for many functions can be found in the source code section, since we use literate programming in GeometryOps.

- Tutorials are meant to teach the fundamental concepts behind GeometryOps, and how to perform certain operations.
- Explanations usually contain little code, and explain in more detail how GeometryOps works.
- Source code usually contains explanations and examples at the top of the page, followed by annotated source code from that file.

## Performance comparison to other packages

From the wonderful [vector-benchmark](https://www.github.com/kadyb/vector-benchmark),
Expand Down

0 comments on commit 14ab5c8

Please sign in to comment.