Restore correct version of README (oops).

This commit is contained in:
Oliver Woodman 2015-12-16 20:49:19 +00:00
parent 7fbffc873c
commit 0dbd7aae54

101
README.md
View File

@ -1,14 +1,10 @@
# ExoPlayer Readme #
# ExoPlayer #
## Description ##
ExoPlayer is an application level media player for Android. It provides an
alternative to Androids MediaPlayer API for playing audio and video both
locally and over the Internet. ExoPlayer supports features not currently
supported by Androids MediaPlayer API, including DASH and SmoothStreaming
adaptive playbacks. Unlike the MediaPlayer API, ExoPlayer is easy to
customize and extend, and can be updated through Play Store application
updates.
ExoPlayer is an application level media player for Android. It provides an alternative to Androids
MediaPlayer API for playing audio and video both locally and over the Internet. ExoPlayer supports
features not currently supported by Androids MediaPlayer API, including DASH and SmoothStreaming
adaptive playbacks. Unlike the MediaPlayer API, ExoPlayer is easy to customize and extend, and can
be updated through Play Store application updates.
## News ##
@ -18,8 +14,7 @@ Read news, hints and tips on the [news][] page.
## Documentation ##
* The [developer guide][] provides a wealth of information to help you get
started.
* The [developer guide][] provides a wealth of information to help you get started.
* The [class reference][] documents the ExoPlayer library classes.
* The [release notes][] document the major changes in each release.
@ -27,37 +22,31 @@ started.
[class reference]: https://google.github.io/ExoPlayer/doc/reference
[release notes]: https://github.com/google/ExoPlayer/blob/dev/RELEASENOTES.md
## Project branches ##
## Using ExoPlayer ##
* The [master][] branch holds the most recent minor release.
* Most development work happens on the [dev][] branch.
* Additional development branches may be established for major features.
#### Via jCenter ####
[master]: https://github.com/google/ExoPlayer/tree/master
[dev]: https://github.com/google/ExoPlayer/tree/dev
## Using Eclipse ##
The repository includes Eclipse projects for both the ExoPlayer library and its
accompanying demo application. To get started:
1. Install Eclipse and setup the [Android SDK][].
1. Open Eclipse and navigate to File->Import->General->Existing Projects into
Workspace.
1. Select the root directory of the repository.
1. Import the ExoPlayerDemo and ExoPlayerLib projects.
[Android SDK]: http://developer.android.com/sdk/index.html
## Using Gradle ##
ExoPlayer can also be built using Gradle. You can include it as a dependent project and build from source:
The easiest way to get started using ExoPlayer is by including the following in your project's
`build.gradle` file:
```
gradle
compile 'com.google.android.exoplayer:exoplayer:rX.X.X'
```
where `rX.X.X` is the your preferred version. For the latest version, see the project's
[Releases][]. For more details, see the project on [Bintray][].
[Releases]: https://github.com/google/ExoPlayer/releases
[Bintray]: https://bintray.com/google/exoplayer/exoplayer/view
#### As source ####
ExoPlayer can also be built from source using Gradle. You can include it as a dependent project like
so:
```
gradle
// settings.gradle
include ':app', ':..:ExoPlayer:library'
@ -67,18 +56,40 @@ dependencies {
}
```
#### As a jar ####
If you want to use ExoPlayer as a jar, run:
```
sh
./gradlew jarRelease
```
and copy library.jar to the libs-folder of your new project.
and copy `library.jar` to the libs folder of your new project.
The project is also available on [jCenter](https://bintray.com/google/exoplayer/exoplayer/view):
## Developing ExoPlayer ##
```
compile 'com.google.android.exoplayer:exoplayer:rX.X.X'
```
#### Project branches ####
Where `rX.X.X` should be replaced with the desired version.
* The [`master`][master] branch holds the most recent minor release.
* Most development work happens on the [`dev`][dev] branch.
* Additional development branches may be established for major features.
[master]: https://github.com/google/ExoPlayer/tree/master
[dev]: https://github.com/google/ExoPlayer/tree/dev
#### Using Android Studio ####
To develop ExoPlayer using Android Studio, simply open the ExoPlayer project in the root directory
of the repository.
#### Using Eclipse ####
To develop ExoPlayer using Eclipse:
1. Install Eclipse and setup the [Android SDK][].
1. Open Eclipse and navigate to File->Import->General->Existing Projects into Workspace.
1. Select the root directory of the repository.
1. Import the projects.
[Android SDK]: http://developer.android.com/sdk/index.html