Skip to content

Commit 661f800

Browse files
authored
Prepare 4.3.0 release
1 parent 93a61c2 commit 661f800

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</td></tr></table>
1313

1414
## Introduction
15-
TuningFork is a library for [libGDX](https://github.com/libgdx/libgdx) that provides advanced audio features. The goal was to make most of the features of [OpenAL](https://github.com/kcat/openal-soft) accessible and provide a comfortable, easy to use, low overhead and object oriented high-level API. In addition, the library offers some convenience features that are needed for most games, such as the music player.<br>
15+
TuningFork is a library for [libGDX](https://github.com/libgdx/libgdx) that provides advanced audio features. The goal was to make most of the features of [OpenAL Soft](https://github.com/kcat/openal-soft) accessible and provide a comfortable, easy to use, low overhead and object oriented high-level API. In addition, the library offers some convenience features that are needed for most games, such as the music player.<br>
1616
Note that TuningFork is not an extension to libGDX audio but a replacement.
1717

1818
### Main Features
@@ -35,6 +35,7 @@ This library widens the range of supported audio formats compared to libGDX, suc
3535
* mp3
3636
* flac
3737
* aiff
38+
* [qoa](https://qoaformat.org/)
3839

3940
### Limitations
4041
* Desktop only
@@ -45,14 +46,14 @@ I didn't want to make any compromises by finding the lowest common denominator b
4546
Add TuningFork as a dependency to your project (I recommend to add it in the core project if you develop for desktop only):
4647
[![Release](https://jitpack.io/v/Hangman/TuningFork.svg)](https://jitpack.io/#Hangman/TuningFork)
4748
```groovy
48-
implementation 'com.github.Hangman:TuningFork:4.2.1'
49+
implementation 'com.github.Hangman:TuningFork:4.3.0'
4950
```
5051

5152
### Compatibility
5253
Java 8 is required, make sure to set `sourceCompatibility = JavaLanguageVersion.of(8)` (or higher) in your gradle scripts.
5354
| Version of libGDX | Latest compatible version of TuningFork |
5455
| :----: | :--- |
55-
| 1.12.1 | 4.2.1 |
56+
| 1.12.1 | 4.3.0 |
5657
| 1.12.0 | 4.1.0 |
5758
| 1.9.12 - 1.11.0 | 3.3.0 |
5859
| 1.9.11 | 2.0.1 |
@@ -67,13 +68,15 @@ The wiki should provide all the information you need to get started quickly. If
6768
[Link to the Wiki!](https://github.com/Hangman/TuningFork/wiki)
6869

6970
## Building From Source
70-
To build TuningFork from source, you need a JDK >= 8 installed. Like [Adoptium JDK](https://adoptium.net/) for example.
71-
TuningFork uses [Gradle](https://gradle.org/) as it's build tool (you don't need to have Gradle installed).
71+
To build the library from source, you need a JDK >= 8 installed. You can grab one here: [Liberica JDK](https://bell-sw.com/pages/downloads/).
72+
TuningFork uses [Gradle](https://gradle.org/) as it's build tool (you don't need to have Gradle installed).
73+
<br>
74+
This will compile the library. The resulting jar can be found under `core/build/libs/`.
7275
```console
7376
./gradlew build
7477
```
75-
Compiles the library. The resulting jar is located under `core/build/libs/`.
78+
79+
This will publish the core artifact to your local Maven repository.
7680
```console
7781
./gradlew publishToMavenLocal
7882
```
79-
Publishes the core artifact to your local Maven repository.

0 commit comments

Comments
 (0)