diff --git a/README.md b/README.md index d85c3a9e..3fa5728f 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,6 @@
@@ -17,6 +16,7 @@ Building - Documentation - Supported Platforms - + Security - License
@@ -158,6 +158,12 @@ need to link with `-latomic`. ABI compatibility is not guaranteed between versions so take care if compiling as a DLL/SO. The suggested way to integrate miniaudio is by adding it directly to your source tree. +You can also use CMake if that's your preference. This will recognize the `vorbisfile` and `opusfile` targets for +the purpose of the libvorbis and libopus decoding backends in the `extras/decoders` folder. If these targets are +unavailable, it will fall back to using `find_library()` in an attempt to find a system-installed version. As a +last resort it will look for the `ogg`, `vorbis`, `opus` and `opusfile` repositories in the `external` folder. If +none of these work, `miniaudio_libvorbis` and `miniaudio_libopus` will be excluded from the build. + Documentation ============= @@ -201,6 +207,13 @@ Backends - Custom +Security +======== +I deal with all security related issues publicly and transparently, and it can sometimes take a while before I +get a chance to address it. If this is an issue for you, you need to use another library. Please post any +security related bugs on the public GitHub issue tracker. + + License ======= Your choice of either public domain or [MIT No Attribution](https://github.com/aws/mit-0).