diff options
Diffstat (limited to 'HOWTO.md')
| -rw-r--r-- | HOWTO.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/HOWTO.md b/HOWTO.md new file mode 100644 index 0000000..afd517e --- /dev/null +++ b/HOWTO.md @@ -0,0 +1,40 @@ +# How To + +This document describes the common commands for building and testing the project. + +## Features + +* **Real-time Audio Synthesis**: The demo features a multi-voice synthesizer that generates audio in real-time from spectrograms. +* **Dynamic Sound Updates**: Spectrograms can be updated dynamically and safely during runtime for evolving soundscapes. + +## Building + +### Debug Build + +```bash +cmake -S . -B build +cmake --build build +``` + +### Size-Optimized Build + +```bash +cmake -S . -B build -DDEMO_SIZE_OPT=ON +cmake --build build +``` + +## Testing + +To build and run the tests, you need to enable the `DEMO_BUILD_TESTS` option in CMake. + +Available test suites: +* `HammingWindowTest`: Verifies the properties of the Hamming window function. +* `SynthEngineTest`: Verifies the core functionality of the audio synthesizer. + +```bash +cmake -S . -B build -DDEMO_BUILD_TESTS=ON +cmake --build build +cd build +ctest +cd .. +``` |
