From ac3ef3d348a8fb5751e63f93836d5aff28e3bfb4 Mon Sep 17 00:00:00 2001
From: Thomas Lambert <t.lambert@uliege.be>
Date: Thu, 2 Feb 2023 20:59:29 +0100
Subject: [PATCH] feat(trouble): add roadmap question
---
contents/user-troubleshooting.tex | 22 ++++++++++++++++------
1 file changed, 16 insertions(+), 6 deletions(-)
diff --git a/contents/user-troubleshooting.tex b/contents/user-troubleshooting.tex
index a3bd503..18aded8 100644
--- a/contents/user-troubleshooting.tex
+++ b/contents/user-troubleshooting.tex
@@ -18,6 +18,10 @@ you find an issue that is not documented here, please check the
\href{\rotareIssuesURL}{issue tracker} and fill a new issue report if
applicable. You can also contact me directly at \myEmail.
+The software contains many checks and is able to detect a common issues by
+itself. Please make sure you read the error message properly as they often
+indicate possible solutions.
+
\section{<Library> cannot be found or cannot be imported}
\label{sec:user:trouble:missingLib}
@@ -27,13 +31,19 @@ and polars manipulations). It seems that these were not installed properly.
Please refer to Chapter~\ref{chap:user:install} for the correct install
procedure.
-If \rotare was cloned using \git, you can simply call the following to download
-the libraries as well:
+If \rotare was cloned using \git but without the \lst{--recursive} tag, you can
+simply call the following to download the libraries as well:
\begin{lstlisting}[language=bash]
git submodule update --init
\end{lstlisting}
-If \rotare was installed manually, you either did not download the libraries or
-did not place them in the correct spot. Normally, you should have the following
-path in the directory:
-\directory{rotare/src/libs/matlab\_airfoil\_toolbox/+af\_tools/}.
+If \rotare was installed manually, you probably did not download the proper
+archive. Please download the archive called \textbf{COMPLETE CODE:
+rotare-X.X.X.zip} and not the "\textit{Source code}" under "\textit{Assets}".
+
+\section{Is <feature> going to be implemented? When?}
+\label{sec:user:trouble:roadmap}
+
+A basic roadmap can be found in the root of the repository. This outlines the
+planned developments and classes them in the most likely order of release. The
+dates of the releases are voluntarily left out to prevent breaking any promises.
--
GitLab