soundbox/Makefile, branch 0.1.0

Fix wrong version string

2024-02-02T20:34:32Z

The `--long` option for `git describe` adds the number of commits since the last release and the Git hash always (even on a release). This is not intended. Removing this option works before and after the first release as expected.

doc: Add license text as appendix

2024-02-02T20:06:23Z

The text of each used license is added to the documentation PDF since this might be passed to third parties without the source or build tree. Adding the licenses to the PDF makes sure they are always accessible.

doc: Make version and date files phony targets

2024-01-31T20:34:17Z

This makes sure that the version / date file is always re-generated. Otherwise it is hard to make sure that e.g. the version is always aligned with the real state.

doc: Add version information to PDF title page

2024-01-30T19:42:07Z

Since otherwise the Git describe output / version information is only embedded into the file name the risk is given that Git version information is lost by renaming the file.

doc: Use Git-provided commit date for PDF

2024-01-27T21:25:30Z

Using the date of the build makes it not-reproducible. This should be avoided. Furthermore the date on the front page should anyway reflect when the source of the document was created. Not when it was converted into a PDF.

Add versioned documentation file in artifacts dir

2024-01-14T14:59:55Z

The full soundbox-- prefix was only used for the artifact tar archive name so far. This has the advantage that the file names inside that archive are shorter like 'documentation.pdf'. But sometimes it is useful to pass only the documentation around as a PDF file because it is easier for people to open it compared to a tar file. For this purpose a second artifact installation for the documentation PDF is added including the soundbox-- prefix.

doc: Remove 'soundbox-' prefix from doc PDF

2024-01-05T09:07:04Z

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.

Introduce 'debug' target

2024-01-05T09:07:04Z

This target will skip generating the artifacts directory. This avoids a bloated build directory while the default target 'all' still generates the artifacts.

Provide artifacts folder including build archives

2024-01-04T20:28:30Z

All build files relevant for users (artifacts) should be provided in build/artifacts. This folder has subdirectories for every revision and a corresponding Zstandard-compressed Tar archive. This archive contains the full result of the build of the current source directory and can easily be shared.

doc: Add automated PDF generation

2024-01-03T11:03:43Z

The build system should convert the documentation source files automatically to a single PDF file to make documentation generation trivial.

Move 'clean' target to root-level Makefile

2024-01-03T11:03:43Z

This target removes the build directory and is thus repository-global.

Switch to repository-global Makefile

2024-01-02T13:24:06Z

The build system of this repository should be used from the repository root. Subdirectories should only contain additional *.mk files which will be included by the central Makefile. This should allow to have dependencies between subdirectories if required and easily allows to build everything.