Skip to content

Commit 076da61

Browse files
Update README prior to 0.9.1 release.
1 parent cd9dc5b commit 076da61

File tree

1 file changed

+37
-8
lines changed

1 file changed

+37
-8
lines changed

README.md

+37-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,46 @@
11
GStreamer 1.x Java Core (gst1-java-core)
22
========================================
33

4-
This is an unofficial set of Java bindings for [GStreamer 1.x][gstreamer], an open-source
4+
This is a set of Java bindings for [GStreamer 1.x][gstreamer], an open-source
55
multimedia framework. The bindings are a fork of the original [GStreamer-Java][gstreamer-java]
66
bindings for GStreamer 0.10.
77

8-
These bindings are still under development. They are now mostly functional, but there has
9-
not yet been a formal first release. Check under [releases][gst1-releases] for latest
10-
test binaries, or build from source.
8+
## Status and support
9+
10+
Releases are available via Maven Central (under the `org.freedesktop.gstreamer` group ID),
11+
or can be downloaded from the GitHub [release page][gst1-releases].
12+
13+
The bindings are currently at version 0.9.x as we progress to a 1.0 release. However,
14+
they are actively in use in a number of open-source and commercial projects, and
15+
should generally be considered stable (they are *more* stable than the 0.10 bindings).
16+
The version number reflects the fact that some work remains to be done to complete the
17+
fork from the 0.10 bindings, which might result in minimal breaking changes.
18+
19+
The current lead maintainer of the bindings is Neil C Smith on behalf of the [Praxis LIVE][praxislive]
20+
project. The original 0.10 project was started by Wayne Meissner, and numerous other
21+
people have made valuable contributions to the original project and the 1.x fork over the years.
22+
23+
Initial help on getting started, and support for open-source projects, can be obtained from the
24+
[GStreamer-Java Google Group][gstreamer-java-group].
25+
26+
Commercial support is available, and sponsorship of features is welcome (it all
27+
helps us get to 1.0!) - please email [email protected] for more information.
28+
29+
## Requirements
1130

1231
The bindings have been tested on Linux, Windows and OSX. You will need to have GStreamer 1.x
13-
available in your path in order to use the bindings. Windows and OSX downloads of GStreamer are
14-
available from the GStreamer project itself.
32+
available in your path in order to use the bindings. Windows and OSX installers for GStreamer are
33+
available from the [GStreamer project itself][gstreamer-download]. Linux users should be
34+
able to get GStreamer from their distribution repository if it isn't already installed.
35+
36+
It is possible to ship GStreamer with your application should you not wish your users
37+
to have to install it separately.
38+
39+
The minimum supported version of GStreamer is 1.8.x.
40+
41+
You will also need the [JNA (Java Native Access)][jna] library, minimum version 4.4.0.
1542

16-
You will also need the [JNA (Java Native Access)][jna] library.
43+
## Usage
1744

1845
See the examples repository for usage. More documentation will follow. Please use the
1946
[GStreamer-Java Google Group][gstreamer-java-group] to discuss usage or ask questions.
@@ -25,7 +52,9 @@ requires people to both know the Java language and be familiar with the GStreame
2552

2653

2754
[gstreamer]: https://gstreamer.freedesktop.org/
55+
[gstreamer-download]: https://gstreamer.freedesktop.org/download/
2856
[gstreamer-java]: https://github.com/gstreamer-java/gstreamer-java
2957
[gst1-releases]: https://github.com/gstreamer-java/gst1-java-core/releases
3058
[gstreamer-java-group]: https://groups.google.com/forum/#!forum/gstreamer-java
31-
[jna]: https://github.com/java-native-access/jna
59+
[jna]: https://github.com/java-native-access/jna
60+
[praxislive]: http://www.praxislive.org

0 commit comments

Comments
 (0)