diff --git a/contents/user-install.tex b/contents/user-install.tex index 4509d8ce78cc22baac812320cca474dc0bc12599..15ab4a5991edb7f3eb710b1d757c4f12a629d8d0 100644 --- a/contents/user-install.tex +++ b/contents/user-install.tex @@ -29,7 +29,7 @@ and moved to the correct place. \label{sec:user:install:git} Navigate to the directory where you want to place \rotare and then simply use -\lst{git --recursive} to download the source code and its libraries. +\lst{git clone --recursive} to download the source code and its libraries. \begin{lstlisting}[language=bash] cd ~/Documents/ @@ -37,8 +37,8 @@ git clone --recursive https://gitlab.uliege.be/thlamb/rotare \end{lstlisting} This is it. You now have the latest stable version of \rotare installed on your -computer. You can now open Matlab and navigate to -\directory{Documents/rotare/src/} to start using \rotare. +computer. You can open Matlab and navigate to \directory{Documents/rotare/src/} +to start using \rotare. \section{Manual install} @@ -47,19 +47,20 @@ computer. You can now open Matlab and navigate to For the manual install you must download the \href{\rotareReleaseURL}{latest stable release} of \rotare and extract the archive where you want. -You must then download each library used by \rotare as well and place it in its -appropriate spot in \directory{rotare/src/llibs/}. +You must then download each library used by \rotare as well and place them in +their appropriate spot in \directory{rotare/src/llibs/}. \begin{itemize} \item \href{\afToolsReleaseURL}{matlab\_airfoil\_toolbox} \end{itemize} -Once everything is extracted and placed in the correct space, \rotare should -work as expected. +Once everything is extracted and placed in the correct sub-directory, \rotare +should work as expected. \section{Update} \label{sec:user:install:update} -Before any update, it is recommended to \textbf{make a backup of your existing +In principle, the update process should never touch any of your files. However, +before any update, it is advised to \textbf{make a backup of your existing configuration files and results} outside of \rotare's working directory. \subsection{Using \git} @@ -68,9 +69,15 @@ Navigate to \rotare's directory and simply run git pull --recurse-submodules \end{lstlisting} This will update \rotare and its libraries. This should not modify your -configuration files or the results you generated. +configuration files or the results you generated. However, if you modified some +portions of the source code, it may fail to update. In that case, follow \git's +instructions to either remove your changes, or commit them and resolve the merge +conflict. \subsection{Manually} Repeat the steps described in Section~\ref{sec:user:install:manual} and copy the new files over the older ones. You could also just extract it somewhere else and move your configurations files and results to the new directory. + +Note that if you modified some files of the source code, a simple copy/past will +erase these changes. diff --git a/rotare-doc.tex b/rotare-doc.tex index 56a5ad7cd8bbddc3837f8e047a6ef6da75cc518e..e3be15c3aa0d5167e4d5ba67013318bb5f8ef853 100644 --- a/rotare-doc.tex +++ b/rotare-doc.tex @@ -131,6 +131,13 @@ draft=false, % toggle if draft version \input{contents/titlepage} % Titlepage \cleardoublepage +% TODO: Add a copyright notice +% Documentation and images are CC-BY-SA-4.0 +% Code is MIT + + + + \currentpdfbookmark{\contentsname}{toc} \setcounter{tocdepth}{2} % define depth of toc \tableofcontents % display table of contents