Commit e49ce7df authored by David Reid's avatar David Reid

Update readme.

parent d672b961
......@@ -8,7 +8,6 @@
<p align="center">
<a href="https://discord.gg/9vpqbjU"><img src="https://img.shields.io/discord/712952679415939085?label=discord&logo=discord&style=flat-square" alt="discord"></a>
<a href="https://fosstodon.org/@mackron"><img src="https://img.shields.io/mastodon/follow/109293691403797709?color=blue&domain=https%3A%2F%2Ffosstodon.org&label=mastodon&logo=mastodon&style=flat-square" alt="mastodon"></a>
<a href="https://www.reddit.com/r/miniaudio"><img src="https://img.shields.io/reddit/subreddit-subscribers/miniaudio?label=r%2Fminiaudio&logo=reddit&style=flat-square" alt="reddit"></a>
</p>
<p align="center">
......@@ -17,6 +16,7 @@
<a href="#building">Building</a> -
<a href="#documentation">Documentation</a> -
<a href="#supported-platforms">Supported Platforms</a> -
<a href="#security">Security</a> -
<a href="#license">License</a>
</p>
......@@ -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).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment