feat: add note about dev version

contents/intro.tex

@@ -37,19 +37,33 @@ The present documentation is divided in two main parts:
     implementation.
 \end{enumerate}
 
+\ifdefined\isdev
+  \section*{Disclaimer}
+  \rotare is still currently under heavy development. The first truly stable
+  version will be numbered \textbf{1.0.0}. Versions prior to this one are
+  \textcolor{ulgRed}{\textbf{not validated and may contain errors and a few
+  bugs}}.
+
+  Starting from v1.0.0, this documentation will reflect the state of the
+  software at each release. Development version of the documentation will be
+  kept as updated as possible with the code. These will be clearly labeled
+  \textcolor{ulgRed}{\textbf{-DEV}} in the titlepage.
+\fi
+
+
 \section*{Features} % (fold)
 \label{sec:features}
 
 \rotare currently supports blade geometries with varying twist, chord and
-airfoil. It can either model single rotors in isolation or coaxial rotors.
-Single rotors can either be studied in steady condition (\eg hovering
-helicopter), axial flow (\eg aircraft propeller, wind turbines) or oblique
-flow\footnote{Only for single rotor cases.}
-(\eg tiltrotor)
+airfoil. At the moment, the software is only able to model single isolated
+rotors. These can be studied in steady conditions (\eg hovering
+helicopter) or axial flows (\eg aircraft propeller, helicopter in climb). More
+complex cases (oblique flows, coaxial rotors, etc.) will be added later on.
 
-Multiple corrections and extensions have been implemented to the base
-methodology, such as: tip/hub losses, compressibility effects, spinner effects,
-etc (see Chapter~\ref{chap:tech:ext}).
+The software currently supports a correction for the tip and hub losses. A few
+other corrections and extensions will be implemented shortly, such as: tip/hub
+losses, compressibility effects, spinner effects, etc (see
+Chapter~\ref{chap:tech:ext} for more details on these extensions).
 
 Different solvers for the BEMT equations are implemented in the software (see
 Chapter~\ref{chap:tech:solvers} for complete description). While they all solve
@@ -58,3 +72,9 @@ resolution or the hypotheses made to solve the equations. Even though some
 solvers are clearly superior to others, this redundant implementation is
 especially useful for teaching purposes. Indeed, it allows to compare the
 quality of the results, the convergence or the effect of additional hypotheses.
+
+While \rotare is not specifically meant for wind turbine, it can model their
+behavior as long as the user specifies all operating conditions (the same way we
+would for an helicopter rotor). \rotare is currently not able to model
+"windmilling" or "autorotation". This will only be added at a later stage of the
+development.

preamble.tex

@@ -18,7 +18,12 @@
 % Document metadata
 % ***********************************************
 \newcommand{\docDate}{\today}
-\newcommand{\docVersion}{v0.0.0}
+\newcommand{\docVersion}{v1.0.0
+  \ifdefined\isdev
+    -\textcolor{ulgRed}{\textbf{DEV}}
+  \fi
+}
+
 \newcommand{\docTitle}{Rotare}
 \newcommand{\docSubtitle}{Documentation}
 \newcommand{\docAuthor}{Thomas Lambert}

rotare-doc.tex

@@ -28,6 +28,8 @@ appendixprefix=false,   % do not display a prefix for appendix chapter
 %draft,            % toggle if draft version
 ]{scrreprt}%
 
+% Comment or uncomment to flag this as a development version
+\def\isdev{1}
 
 % Main document preamble
 \input{preamble.tex}