summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2024-01-30 20:55:46 +0100
committerxengineering <me@xengineering.eu>2024-01-30 20:55:46 +0100
commit32be56460a716aa0a1e14b9c29b1b98fb8fe4750 (patch)
treea600587e3a32dbea2a72fdea2d283de5ac12cb2b /doc
parent57e12bcf9aafcd6bea41e895e14fdd2e6f6d8479 (diff)
downloadsoundbox-32be56460a716aa0a1e14b9c29b1b98fb8fe4750.tar
soundbox-32be56460a716aa0a1e14b9c29b1b98fb8fe4750.tar.zst
soundbox-32be56460a716aa0a1e14b9c29b1b98fb8fe4750.zip
doc: Add section 'Getting soundbox'
Diffstat (limited to 'doc')
-rw-r--r--doc/documentation.tex19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index 0a59c7e..dd2778d 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -57,6 +57,25 @@ below.
Improvements regarding these limitations are planned but future progress cannot
be guaranteed.
+\section{Getting soundbox}
+
+Further information might be available via the \texttt{soundbox} project
+page\footnote{\href{https://xengineering.eu/git/soundbox}{https://xengineering.eu/git/soundbox}}.
+The source code can be browsed on the cgit
+instance\footnote{\href{https://cgit.xengineering.eu/soundbox}{https://cgit.xengineering.eu/soundbox}}
+hosting the \texttt{soundbox} code.
+
+The complete source code can be retrieved with the version control software
+Git\footnote{\href{https://git-scm.com/}{https://git-scm.com/}}.
+
+\begin{verbatim}
+git clone https://cgit.xengineering.eu/soundbox
+\end{verbatim}
+
+The included \texttt{README.md} file describes how to generate all required
+files from the source code. This is currently the only way to get them. This
+PDF file is one of the resulting files.
+
\chapter{User guide}
In addition to \autoref{chap:introduction} `\nameref{chap:introduction}` the