diff options
| author | xengineering <me@xengineering.eu> | 2024-01-08 21:37:16 +0100 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2024-01-10 21:31:03 +0100 |
| commit | 97a93cceebe020deae315560f9e186dfcb0ba92e (patch) | |
| tree | 40f91996a053b0ba3e6b126b5a3476b07fcc4679 /doc/documentation.tex | |
| parent | 746e5c56f7f2fb0299ee66d6e89ec4783e72ff1f (diff) | |
| download | soundbox-semver.tar soundbox-semver.tar.zst soundbox-semver.zip | |
WIP: doc: Add API structure from developer perspectivesemver
Diffstat (limited to 'doc/documentation.tex')
| -rw-r--r-- | doc/documentation.tex | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index 91ff8e5..5713b3c 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -30,13 +30,20 @@ Versioning\footnote{\href{https://semver.org}{https://semver.org}}. The resulting version numbers have the format \texttt{<major>.<minor>.<patch>} like e.g. \texttt{2.0.3}. While Semantic Versioning is usually targeted at software only it is here used for the whole device. This includes mechanical, electronic -and software aspects as shown in figure \ref{diagram:device-semver}. +and software aspects as shown in figure \ref{diagram:device-semver-user}. \begin{figure}[h] \centering - \includegraphics[width=\textwidth]{device-semver.pdf} - \caption{API for a device versioned with Semantic Versioning} - \label{diagram:device-semver} + \includegraphics[width=\textwidth]{device-semver-user.pdf} + \caption{API for a device versioned with Semantic Versioning from a user perspective} + \label{diagram:device-semver-user} +\end{figure} + +\begin{figure}[h] + \centering + \includegraphics[width=\textwidth]{device-semver-developer.pdf} + \caption{API for a device versioned with Semantic Versioning from a developer perspective} + \label{diagram:device-semver-developer} \end{figure} This versioning makes sure that users do not have to care about the device |