From 841cc171f63bda97e3c48e3bd9b5f9c4295e6989 Mon Sep 17 00:00:00 2001 From: Gavin Wiggins <6828967+wigging@users.noreply.github.com> Date: Tue, 31 Dec 2024 14:14:36 -0500 Subject: [PATCH] Add links to module documentation --- Sources/Numerix/Documentation.docc/Numerix.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/Sources/Numerix/Documentation.docc/Numerix.md b/Sources/Numerix/Documentation.docc/Numerix.md index ba1d040..f62c3d1 100644 --- a/Sources/Numerix/Documentation.docc/Numerix.md +++ b/Sources/Numerix/Documentation.docc/Numerix.md @@ -4,7 +4,14 @@ Linear algebra and numerical computing with Swift on Apple devices. ## Overview -Numerix is an open-source Swift package that provides Vector and Matrix structures for performing linear algebra and other numerical computations on Apple devices. It uses the Accelerate framework for high-performance and energy-efficient calculations. See the module documentation for more information about the Vector and Matrix structures. +Numerix is an open-source Swift package that provides vector and matrix structures for performing linear algebra and other numerical computations on Apple devices. It uses the Accelerate framework for high-performance and energy-efficient calculations. See the Modules documentation for more information about the vector and matrix structures. + +## Modules + +Numerix is comprised of modules that provide complex number, vector, matrix, and shaped array structures for working with numerical data. Documentation for each module is available at: + +- [Vector Module](./VectorModule) +- [Matrix Module](./MatrixModule) ## Contributing