From c2d8261aba307223d3f1edce3a88a4d212395e4a Mon Sep 17 00:00:00 2001 From: xengineering Date: Thu, 4 Jan 2024 21:35:23 +0100 Subject: doc: Remove 'soundbox-' prefix from doc PDF Inside the artifacts folder aswell as inside the source folder adding a 'soundbox-' prefix to files is uncommon. In both cases only the root level folder should contain the name 'soundbox' to remove redundancies. --- doc/doc.mk | 2 +- doc/documentation.tex | 35 +++++++++++++++++++++++++++++++++++ doc/soundbox-documentation.tex | 35 ----------------------------------- 3 files changed, 36 insertions(+), 36 deletions(-) create mode 100644 doc/documentation.tex delete mode 100644 doc/soundbox-documentation.tex (limited to 'doc') diff --git a/doc/doc.mk b/doc/doc.mk index 059bd10..0ad8c3a 100644 --- a/doc/doc.mk +++ b/doc/doc.mk @@ -1,5 +1,5 @@ DOC_BUILD_DIR := $(BUILD_DIR)/doc -DOCS := soundbox-documentation +DOCS := documentation PDF := $(DOCS:%=$(DOC_BUILD_DIR)/%.pdf) .PHONY: doc diff --git a/doc/documentation.tex b/doc/documentation.tex new file mode 100644 index 0000000..14cf828 --- /dev/null +++ b/doc/documentation.tex @@ -0,0 +1,35 @@ +\documentclass{report} +\author{xengineering} +\title{soundbox documentation} + +\begin{document} + +\maketitle +\newpage + +\tableofcontents +\newpage + +\chapter{Introduction} + +\texttt{soundbox} is a device to connect classic audio systems to the network. + +%\section{Versioning} +%\section{Licensing} + +%\chapter{User guide} +%\section{Device setup} +%\section{Playing audio} + +%\chapter{Production} +%\section{Printing mechanical parts} +%\section{Install operating system to SD card} +%\section{Final assembly} + +%\chapter{Device internals} +%\section{Mechanical design} +%\section{Electronics} +%\section{Operating system} +%\section{Software} + +\end{document} diff --git a/doc/soundbox-documentation.tex b/doc/soundbox-documentation.tex deleted file mode 100644 index 14cf828..0000000 --- a/doc/soundbox-documentation.tex +++ /dev/null @@ -1,35 +0,0 @@ -\documentclass{report} -\author{xengineering} -\title{soundbox documentation} - -\begin{document} - -\maketitle -\newpage - -\tableofcontents -\newpage - -\chapter{Introduction} - -\texttt{soundbox} is a device to connect classic audio systems to the network. - -%\section{Versioning} -%\section{Licensing} - -%\chapter{User guide} -%\section{Device setup} -%\section{Playing audio} - -%\chapter{Production} -%\section{Printing mechanical parts} -%\section{Install operating system to SD card} -%\section{Final assembly} - -%\chapter{Device internals} -%\section{Mechanical design} -%\section{Electronics} -%\section{Operating system} -%\section{Software} - -\end{document} -- cgit v1.2.3-70-g09d2