| Age | Commit message (Collapse) | Author |
|---|
|
This section is important to communicate how to interpret version
numbers in the context of this device repository.
|
|
This is required to build the table of contents and similar parts of the
document correctly.
|
|
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.
|
|
|
|
This document will be quite long. Thus the report document class is more
suitable.
|
|
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.
|
|
The build system should convert the documentation source files
automatically to a single PDF file to make documentation generation
trivial.
|
|
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.
|
|
This license should cover the documentation of soundbox because software
licenses like the AGPL or hardware licenses like OHL are not well
suited.
|
