summaryrefslogtreecommitdiff
path: root/doc/soundbox-documentation.tex
AgeCommit message (Collapse)Author
2024-01-05doc: Remove 'soundbox-' prefix from doc PDFxengineering
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.
2024-01-03doc: Add brief description for first chapterxengineering
2024-01-03doc: Switch from LaTeX article to reportxengineering
This document will be quite long. Thus the report document class is more suitable.
2024-01-03doc: Draft structure for PDF documentationxengineering
This draft should give an overview of the planned sections which is useful to decide what should belong into the first sections and what should be written in later ones.
2024-01-03doc: Add soundbox-documentation.texxengineering
This LaTeX document should contain the full device documentation for soundbox. It will not cover aspects about the source or how to build. This should be covered inside the README of this repository. Everything else will be part of the resulting documentation PDF file.