From 14ab5c870a4f1059f477400f8a0fe08f5296ba42 Mon Sep 17 00:00:00 2001 From: Anshul Singhvi Date: Mon, 24 Jun 2024 17:15:59 -0400 Subject: [PATCH] Describe how to navigate docs (#165) --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index ae0922347..4c6fd6d53 100644 --- a/README.md +++ b/README.md @@ -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),