docs: Add user manual

onera · Dec 18, 2023 · 10d9f31 · 10d9f31
1 parent 03e1a4b
commit 10d9f31
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/Documentation/CoMMA_user_manual.pdf b/Documentation/CoMMA_user_manual.pdf
diff --git a/README.md b/README.md
@@ -77,6 +77,15 @@ and related html pages will be built in `documentation`.
 An [online version](https://numerics.gitlab-pages.onera.net/solver/comma/) of
 the doc hosted by GitLab is available.
 
+A user manual is also available, see
+[Documentation/CoMMA_user_manual.pdf](Documentation/CoMMA_user_manual.pdf). The
+goal of this document is to clearly state and explain how CoMMA works, that
+applies both to algorithms and their actual implementation (e.g., which data
+structures have been used). After having read this document, the user should be
+able to understand what CoMMA actually does under the hood and should have the
+essential insights to use it (e.g., which input parameters should one provides,
+how they will impact the final results...).
+
 ## :bulb: Examples
 Here are two animations about the agglomeration on a 2D mesh of a ring for two
 different option settings: