From e4b742cff3e8e5b70824cbe01e69ec4e6c2914f9 Mon Sep 17 00:00:00 2001
From: Loic Guegan <manzerbredes@mailbox.org>
Date: Wed, 14 Sep 2022 08:24:29 +0200
Subject: Update manual

---
 manual/manual.tex | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

(limited to 'manual/manual.tex')

diff --git a/manual/manual.tex b/manual/manual.tex
index ed7508f..fe3dac4 100644
--- a/manual/manual.tex
+++ b/manual/manual.tex
@@ -48,6 +48,8 @@
 \end{titlepage}
 \pagebreak
 
+\tableofcontents
+\pagebreak
 
 \section{Architecture of ESDS}
 
@@ -88,7 +90,7 @@ the last \verb|platform.yaml| file:
 \subsection{Execution}
 \label{sec:firstsimulation:execution}
 
-To execute our first simulation, the following command should be executed from the same folder
+To run our first simulation, the following command can be run:
 that contains \verb|platform.yaml| and \verb|node.py|:
 \begin{verbatim}
   > esds run platform.yaml
@@ -120,7 +122,7 @@ As explain in Section \ref{sec:firstsimulation:platform}, esds platform files co
 \end{enumerate}
 Lets see in details the format of each section.
 
-\subsection{General}
+\subsection{The general section}
 This section is used to settings up the overall parameters of esds. Table \ref{keywords:general} reference all the keywords for this section of the platform file.
 
 \begin{table}
@@ -148,7 +150,7 @@ debug_file: "./myfile.txt"
     \end{tabminted}
     \\ \cmidrule{1-3}
     
-    \textbf{breakpoints} & Specify a list of simulated time (in seconds) at which esds should interrupt and call the specified callback &
+    \textbf{breakpoints} & Specify a list of simulated time (in seconds) at which esds must interrupt and call the specified callback &
     \begin{tabminted}{yaml}
 breakpoints: [5, 6, 7]
     \end{tabminted}
@@ -173,7 +175,7 @@ breakpoints_callback:
   \label{keywords:general}
 \end{table}
 
-\subsection{Node}
+\subsection{The node section}
 The node section is used configure the simulated node of esds. Table \ref{keywords:nodes} references
 all the keywords used in the nodes section.
 
@@ -198,7 +200,7 @@ implementations:
     \end{tabminted}
     \\ \cmidrule{1-3}
     
-    \textbf{arguments} & Define the arguments that should be pass to each node implementation (keys of each element uses \textbf{the range syntax}) &
+    \textbf{arguments} & Define the arguments that will be passed to each node implementation (keys of each element uses \textbf{the range syntax}) &
     \begin{tabminted}{yaml}
 arguments: {
         "all": 2 
@@ -211,16 +213,16 @@ arguments: {
   \label{keywords:nodes}
 \end{table}
 
-Many entries in the platform file use a \textbf{range syntax} to map informations (node
-implementations, links etc.) to node ids. Indeed, when running a simulation with $p$ nodes, each
-node will have an allocated $id$ such that $id \in [0,1,...,p-1]$. Here are examples of the range
+Several entries in the platform file use a \textbf{range syntax} to map informations (node
+implementations, links etc.) to node $ids$. Indeed, when running a simulation with $p$ nodes, each
+node will have an allocated $id$ such that $id \in [0,1,...,p-1]$. Here are examples of valid range
 syntax for a simulation that uses 5 nodes:
 \begin{itemize}
 \item \makebox[2cm]{\textbf{0,1,2,3}\hfill} Node 0,1,2 and 3
 \item \makebox[2cm]{\textbf{0-2}\hfill} Node 0,1 and 2
 \item \makebox[2cm]{\textbf{all}\hfill} Node 0,1,2,3 and 4
 \item \makebox[2cm]{\textbf{2-@}\hfill} Node 2,3 and 4
-\item \makebox[2cm]{\textbf{0-@}\hfill} Node 0,1,2,3 and 4
+\item \makebox[2cm]{\textbf{0-@}\hfill} Node 0,1,2,3 and 4 (same as \textbf{all})
 \end{itemize}
 
 \end{document}
-- 
cgit v1.2.3

