Skip to content
Snippets Groups Projects
Verified Commit 373ac658 authored by Thomas Lambert's avatar Thomas Lambert :helicopter:
Browse files

fix(install): recommend manual over git

Now that I bundle the submodules in the archive using git-archive-all
from the CI/CD, it is actually better and safer to download the stable
version of Rotare in stead of relying the main branch with git.
parent b7d16f9e
No related branches found
No related tags found
No related merge requests found
Pipeline #11426 passed
......@@ -13,19 +13,35 @@
\chapter{Install guide}
\label{chap:user:install}
\rotare does not require any specific external program to be installed. So the
\rotare does not require any specific external program to be installed. The
install process is just a question of downloading the \matlab script and
functions and placing them in at the correct place.
There are multiple possibilities to install \rotare on your system. As \rotare
code uses libraries as sub modules, the preferred install method is to use \git.
This will ensure everything is up-to-date and installed at the correct place
automatically. If \git is not available, you can manually download the archives
for \rotare and each of its libraries. The libraries will then have to extracted
and moved to the correct place.
There are two possibilities to install \rotare on your system.
\begin{enumerate}
\item Downloading the source code of the latest stable release from the
release page
\item Cloning the repository with git
\end{enumerate}
The manual download of files is recommended as it is easier, will not require
any specific knowledge about \git and will always download the latest
\textit{stable} release of \rotare.
The \git method should be reserved to more advanced users. With this you will
have the latest developments, but some bugs are more likely to happen.
\section{Manual install (recommended)}
\label{sec:user:install:manual}
For the manual install you must download the \href{\rotareReleaseURL}{latest
stable release} of \rotare and extract the archive on your computer.
\danger In order to download the \textit{complete} software (\ie the code and
the libraries) you must download the item called \textbf{Complete Code:
rotare-x.x.x.zip}. The items marked as \textit{source code} under
\textit{assets} do not contain the mandatory libraries and will prevent \rotare
from running properly.
\section{Install using \git (recommended)}
\section{Install using \git}
\label{sec:user:install:git}
Navigate to the directory where you want to place \rotare and then simply use
......@@ -36,26 +52,11 @@ cd ~/Documents/
git clone --recursive https://gitlab.uliege.be/rotare/rotare
\end{lstlisting}
This is it. You now have the latest stable version of \rotare installed on your
computer. You can open Matlab and navigate to \directory{Documents/rotare/src/}
to start using \rotare.
\section{Manual install}
\label{sec:user:install:manual}
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 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 sub-directory, \rotare
should work as expected.
This is it. You now have the most up-to-date version of \rotare installed on
your computer. Note that this version may not be completely stable.
You can open Matlab and navigate to \directory{Documents/rotare/src/} to start
using \rotare.
\section{Update}
\label{sec:user:install:update}
......@@ -63,7 +64,24 @@ 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}
\subsection{Before updating}
Prior to any update, it is heavily recommended to review the changelog (and/or
the release notes) and make sure the update does not introduce some breaking
changes. Normally, this should only be the case for Major versions of the code
(\eg going from 1.x.x to 2.x.x).
If any breaking change is documented, please review the changelog or this
documentation and proceed to the necessary adaptations.
\subsection{Manual update}
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/paste
will erase these changes.
\subsection{Update using \git}
Navigate to \rotare's directory and simply run
\begin{lstlisting}[language=bash]
git pull --recurse-submodules
......@@ -73,11 +91,3 @@ 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.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment