From d88fe89e1d8c0e6ff3c88dfc8d7d45c80ef49a09 Mon Sep 17 00:00:00 2001
From: Florent Pruvost <florent.pruvost@inria.fr>
Date: Tue, 12 Sep 2017 11:18:03 +0200
Subject: [PATCH] add the sections of chapters for clarity
---
README.org | 16 ++++++++++------
doc/orgmode/chapters/installing.org | 2 +-
2 files changed, 11 insertions(+), 7 deletions(-)
diff --git a/README.org b/README.org
index 8acc071e3..ea5268fb4 100644
--- a/README.org
+++ b/README.org
@@ -46,9 +46,16 @@ dedicated to dense linear algebra.
** User guide
The user guide is available directly in the sources as emacs
orgmode files, see :
- 1) [[file:doc/orgmode/chapters/introduction.org][Introduction]]
- 2) [[file:doc/orgmode/chapters/installing.org][Installing]]
- 3) [[file:doc/orgmode/chapters/using.org][Using]]
+ 1) [[file:doc/orgmode/chapters/introduction.org][Introduction]] : description of the scientific context
+ 2) [[file:doc/orgmode/chapters/installing.org][Installing]] :
+ * Getting Chameleon
+ * Prerequisites for installing Chameleon
+ * Distribution of Chameleon using Spack
+ * Build and install Chameleon with CMake
+ 3) [[file:doc/orgmode/chapters/using.org][Using]] :
+ * Linking an external application with Chameleon libraries
+ * Using Chameleon executables
+ * Chameleon API
This documentation could also be generated in html and/or pdf :
#+begin_src
@@ -66,9 +73,6 @@ dedicated to dense linear algebra.
** For developers
Please refer to the [[file:READMEDEV.org][READMEDEV]] page.
-* Installation
- Please refer to the [[file:doc/orgmode/chapters/installing.org][Installing]] page.
-
* Get involved!
** Mailing list
diff --git a/doc/orgmode/chapters/installing.org b/doc/orgmode/chapters/installing.org
index 9954d1714..c106f2770 100644
--- a/doc/orgmode/chapters/installing.org
+++ b/doc/orgmode/chapters/installing.org
@@ -24,7 +24,7 @@ we encourage users to use the /morse/ branch of [[sec:spack][Spack]].
git clone --recursive https://gitlab.inria.fr/solverstack/chameleon.git
#+end_src
-** Prerequisites to install Chameleon
+** Prerequisites for installing Chameleon
To install Chameleon's libraries, header files, and executables, one
needs:
--
GitLab