Skip to content

Commit f802c60

Browse files
committed
enhance Core readme
1 parent 8139d4c commit f802c60

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

GeometryOpsCore/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22

33
This is a "core" package for [GeometryOps.jl](https://github.com/JuliaGeo/GeometryOps.jl), that defines some basic primitive functions and types for GeometryOps.
44

5-
Generally, you would depend on this to use either the GeometryOps types (like `Linear`, `Spherical`, etc) or the primitive functions like `apply`, `applyreduce`, `flatten`, etc.
5+
It defines, all in all:
6+
- Manifolds and the manifold interface
7+
- The Algorithm type and the algorithm interface
8+
- Low level functions like apply, applyreduce, flatten, etc.
9+
- Common methods that should work across all geometries!
10+
11+
Generally, you would depend on this to use either the GeometryOps types (like `Planar`, `Spherical`, etc) or the primitive functions like `apply`, `applyreduce`, `flatten`, etc.
612
All of these are also accessible from GeometryOps, so it's preferable that you use GeometryOps directly.
713

814
Tests are in the main GeometryOps tests, we don't have separate tests for GeometryOpsCore since it's in a monorepo structure.

0 commit comments

Comments
 (0)