Skip to content

Commit

Permalink
simplify version description
Browse files Browse the repository at this point in the history
  • Loading branch information
lebedec committed May 10, 2024
1 parent 77ee3d9 commit 4339ed1
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,18 @@ and abstract away uncomfortable manual C interface using.

### Installation

A crate uses FMOD development libraries version to simplify version match and avoid link-time errors because of
incompatible FMOD API changes in patched versions.
Choose one of FMOD supported versions:

FMOD API version encoded in left-most major and minor components. But changes and bug fixes in library wrapper encoded
using patch component, such as `2.206.1` or `2.217.1`.

For example for FMOD Engine 2.02.06 you should use:
| libfmod | FMOD |
|---------|---------|
| 2.222.1 | 2.02.22 |
| 2.206.5 | 2.02.06 |

```toml
[dependencies]
libfmod = "~2.206"
libfmod = "2.206.5"
```

That means that if backwards compatible bug fix `2.206.2` is published, that will be chosen as the greatest
release for your project with FMOD 2.02.06 version.

#### FMOD Development Libraries

FMOD development libraries can't be integrated and distributed as part of this crate.
Expand Down Expand Up @@ -76,15 +72,16 @@ You may also place the files in location in which Rust searches for dynamic libr
~/lib/
```

⚠️ When you're shipping your application make sure to copy FMOD libraries to the same directory that your executable is in.
⚠️ When you're shipping your application make sure to copy FMOD libraries to the same directory that your executable is
in.

**Why no build options?**

* FMOD does not allow static linking
* The crate not implement dynamic loading, only dynamic linking
* There is no simple way to control how Rust search for libraries

So, we can provide some configuration (e.g "FMOD_SDK" location variable), but this is not useful
So, we can provide some configuration (e.g "FMOD_SDK" location variable), but this is not useful
because you still have to install the FMOD libraries as described above.

### Features
Expand Down

0 comments on commit 4339ed1

Please sign in to comment.