zdoom/fluidsynth
0
0
Fork 0
mirror of https://github.com/ZDoom/fluidsynth.git synced 2025-02-20 19:02:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

reformat test/README.md

Browse source
This commit is contained in:
derselbst 2018-04-08 09:41:15 +02:00
parent c58f3eb868
commit b34e5bbc36
1 changed files with 16 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
test/README.md
View file

@ -1,6 +1,19 @@
This directory contains small executables to verify fluidsynths correct behaviour, i.e. unit tests. Although some tests might serve as educational demonstration of how to use certain parts of fluidsynth, they are **not** intended to do so! It is most likely that those tests will consist of many hacky parts that are necessary to test fluidsynth (e.g. including fluidsynth's private headers to access internal data types and functions). For user applications this programming style is strongly discouraged! Do **not** blindly use the tests as template for your application! Keep referring to the documentation and code examples listed in the [API documentation](http://www.fluidsynth.org/api/).
This directory contains small executables to verify fluidsynths correct behaviour, i.e. unit tests.
### Developers
#### Do *not* blindly use the tests as template for your application!
To add a unit test just duplicate an existing one, give it a unique name and update the CMakeLists.txt by adding a call to ADD_FLUID_TEST() and a dependency to the custom `check` target. Make sure you call cmake with `-Denable-tests=1` to build and execute the tests via `make check`.
Although some tests might serve as educational demonstration of how to use certain parts of fluidsynth,
they are **not** intended to do so! It is most likely that those tests will consist of many hacky parts
that are necessary to test fluidsynth (e.g. including fluidsynth's private headers to access internal
data types and functions). For user applications this programming style is strongly discouraged!
Keep referring to the documentation and code examples listed in the [API documentation](http://www.fluidsynth.org/api/).
#### Developers
To add a unit test just duplicate an existing one, give it a unique name and update the CMakeLists.txt by
* adding a call to `ADD_FLUID_TEST()` and
* a dependency to the custom `check` target.
Make sure you call cmake with `-Denable-tests=1` to build and execute the tests via `make check`.