Skip to content

Commit a432396

Browse files
committed
Slim down the readme
Versioning is a weird topic, as every Bevy release is a breaking release. Unless there is a need for a dependency matrix, I will stop maintaining it for now. But, FMOD updates are infrequent and backwards compatible. So need for a badge for now.
1 parent d75e5e3 commit a432396

File tree

1 file changed

+9
-27
lines changed

1 file changed

+9
-27
lines changed

README.md

Lines changed: 9 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# bevy_fmod
22

3-
![Latest compatible Bevy version][Bevy 0.13 img]
4-
![Latest compatible FMOD version][FMOD 2.02.20 img]
3+
![Latest compatible Bevy version][Bevy badge]
54
![License][License img]
65
![GitHub release][GitHub release img]
76

@@ -20,7 +19,8 @@ Learn more [here][FMOD attribution].
2019

2120
## Supported platforms
2221

23-
Currently, this crate is only tested and developed for Windows (non-UWP) and Linux. More platforms are planned eventually.
22+
Currently, this crate is only tested and developed for Windows (non-UWP) and Linux. More platforms are planned
23+
eventually.
2424

2525
MacOS: https://github.com/Salzian/bevy_fmod/issues/2
2626
Web: https://github.com/Salzian/bevy_fmod/issues/51
@@ -34,7 +34,8 @@ libraries [here][FMOD libraries download].
3434
This requires a free FMOD account.
3535

3636
### Windows
37-
- Download the "FMOD Engine" package for Windows. Make sure to select [a compatible version](#versioning).
37+
38+
- Download the "FMOD Engine" package for Windows.
3839
- Install the package.
3940
- You need the following 4 files in the root of your rust project:
4041
- `api/core/lib/x64/fmod.dll`
@@ -44,9 +45,10 @@ This requires a free FMOD account.
4445

4546
### Linux
4647

47-
Below are the steps for a fairly minimal method to link the libraries. See the comments in [build.rs](https://github.com/Salzian/bevy_fmod/blob/main/build.rs) for more information.
48+
Below are the steps for a fairly minimal method to link the libraries. See the comments
49+
in [build.rs](https://github.com/Salzian/bevy_fmod/blob/main/build.rs) for more information.
4850

49-
- Download the "FMOD Engine" package for Linux. Make sure to select [a compatible version](#versioning).
51+
- Download the "FMOD Engine" package for Linux.
5052
- Create a new folder `fmod` in the root of your project.
5153
- Extract the `api` folder into it.
5254
- Copy the contents of [build.rs](https://github.com/Salzian/bevy_fmod/blob/main/build.rs) into your own build script.
@@ -84,29 +86,9 @@ to explicitly enable it with the `--features` flag. This way, you won't accident
8486
cargo run --example minimal --features live-update
8587
```
8688

87-
## Versioning
88-
89-
| bevy_fmod | Bevy | FMOD (tested version, newer may work) |
90-
|-----------|---------------------------------------|-------------------------------------------------------|
91-
| 0.4.0 | [![0.13][Bevy 0.13 img]][Bevy 0.13] | [![2.02.20][FMOD 2.02.20 img]][FMOD revision history] |
92-
| 0.3.0 | [![0.11.2][Bevy 0.11 img]][Bevy 0.11] | [![2.02.12][FMOD 2.02.12 img]][FMOD revision history] |
93-
| 0.2.0 | [![0.11.2][Bevy 0.11 img]][Bevy 0.11] | [![2.02.12][FMOD 2.02.12 img]][FMOD revision history] |
94-
| 0.1.0 | [![0.10.0][Bevy 0.10 img]][Bevy 0.10] | [![2.02.12][FMOD 2.02.12 img]][FMOD revision history] |
95-
| 0.0.1 | [![0.10.0][Bevy 0.10 img]][Bevy 0.10] | [![2.02.12][FMOD 2.02.12 img]][FMOD revision history] |
96-
9789
[Bevy]: https://bevyengine.org
9890

99-
[Bevy 0.10]: https://bevyengine.org/news/bevy-0-10/
100-
101-
[Bevy 0.10 img]: https://img.shields.io/badge/Bevy-0.10-232326
102-
103-
[Bevy 0.11]: https://bevyengine.org/news/bevy-0-11/
104-
105-
[Bevy 0.11 img]: https://img.shields.io/badge/Bevy-0.11-232326
106-
107-
[Bevy 0.13]: https://bevyengine.org/news/bevy-0-13/
108-
109-
[Bevy 0.13 img]: https://img.shields.io/badge/Bevy-0.13-232326
91+
[Bevy badge]: https://img.shields.io/badge/Bevy-0.14-232326
11092

11193
[FMOD licensing]: https://fmod.com/licensing
11294

0 commit comments

Comments
 (0)