Mechanical README cleanups

PiperOrigin-RevId: 401767060
ened · Oct 9, 2021 · e7c6ed5 · e7c6ed5
1 parent 1d29f12
commit e7c6ed5
Show file tree

Hide file tree

Showing 28 changed files with 144 additions and 144 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# ExoPlayer <img src="https://img.shields.io/github/v/release/google/ExoPlayer.svg?label=latest"/> #
+# ExoPlayer <img src="https://img.shields.io/github/v/release/google/ExoPlayer.svg?label=latest"/>
 
 ExoPlayer is an application level media player for Android. It provides an
 alternative to Android’s MediaPlayer API for playing audio and video both
@@ -7,7 +7,7 @@ supported by Android’s 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.
 
-## Documentation ##
+## Documentation
 
 * The [developer guide][] provides a wealth of information.
 * The [class reference][] documents ExoPlayer classes.
@@ -20,7 +20,7 @@ and extend, and can be updated through Play Store application updates.
 [release notes]: https://github.com/google/ExoPlayer/blob/release-v2/RELEASENOTES.md
 [developer blog]: https://medium.com/google-exoplayer
 
-## Using ExoPlayer ##
+## Using ExoPlayer
 
 ExoPlayer modules can be obtained from [the Google Maven repository][]. It's
 also possible to clone the repository and depend on the modules locally.
@@ -29,7 +29,7 @@ also possible to clone the repository and depend on the modules locally.
 
 ### From the Google Maven repository
 
-#### 1. Add ExoPlayer module dependencies ####
+#### 1. Add ExoPlayer module dependencies
 
 The easiest way to get started using ExoPlayer is to add it as a gradle
 dependency in the `build.gradle` file of your app module. The following will add
@@ -77,7 +77,7 @@ found on the [Google Maven ExoPlayer page][].
 [extensions directory]: https://github.com/google/ExoPlayer/tree/release-v2/extensions/
 [Google Maven ExoPlayer page]: https://maven.google.com/web/index.html#com.google.android.exoplayer
 
-#### 2. Turn on Java 8 support ####
+#### 2. Turn on Java 8 support
 
 If not enabled already, you also need to turn on Java 8 support in all
 `build.gradle` files depending on ExoPlayer, by adding the following to the
@@ -89,13 +89,13 @@ compileOptions {
 }
 ```
 
-#### 3. Enable multidex ####
+#### 3. Enable multidex
 
 If your Gradle `minSdkVersion` is 20 or lower, you should
 [enable multidex](https://developer.android.com/studio/build/multidex) in order
 to prevent build errors.
 
-### Locally ###
+### Locally
 
 Cloning the repository and depending on the modules locally is required when
 using some ExoPlayer extension modules. It's also a suitable approach if you
@@ -128,15 +128,15 @@ implementation project(':exoplayer-library-dash')
 implementation project(':exoplayer-library-ui')
 ```
 
-## Developing ExoPlayer ##
+## Developing ExoPlayer
 
-#### Project branches ####
+#### Project branches
 
 * Development work happens on the `dev-v2` branch. Pull requests should
   normally be made to this branch.
 * The `release-v2` branch holds the most recent release.
 
-#### Using Android Studio ####
+#### Using Android Studio
 
 To develop ExoPlayer using Android Studio, simply open the ExoPlayer project in
 the root directory of the repository.
diff --git a/demos/cast/README.md b/demos/cast/README.md
@@ -1,4 +1,4 @@
-# Cast demo application #
+# Cast demo application
 
 This folder contains a demo application that showcases ExoPlayer integration
 with Google Cast.

diff --git a/demos/main/README.md b/demos/main/README.md
@@ -1,4 +1,4 @@
-# ExoPlayer main demo #
+# ExoPlayer main demo
 
 This is the main ExoPlayer demo application. It uses ExoPlayer to play a number
 of test streams. It can be used as a starting point or reference project when

diff --git a/docs/README.md b/docs/README.md
@@ -1,4 +1,4 @@
-# ExoPlayer website #
+# ExoPlayer website 
 
 The [ExoPlayer website](https://exoplayer.dev/) is hosted on
 GitHub Pages, and is statically generated using Jekyll.

diff --git a/extensions/av1/README.md b/extensions/av1/README.md
@@ -1,17 +1,17 @@
-# ExoPlayer AV1 extension #
+# ExoPlayer AV1 extension
 
 The AV1 extension provides `Libgav1VideoRenderer`, which uses libgav1 native
 library to decode AV1 videos.
 
-## License note ##
+## License note
 
 Please note that whilst the code in this repository is licensed under
 [Apache 2.0][], using this extension also requires building and including one or
 more external libraries as described below. These are licensed separately.
 
 [Apache 2.0]: https://github.com/google/ExoPlayer/blob/release-v2/LICENSE
 
-## Build instructions (Linux, macOS) ##
+## Build instructions (Linux, macOS)
 
 To use this extension you need to clone the ExoPlayer repository and depend on
 its modules locally. Instructions for doing this can be found in ExoPlayer's
@@ -61,14 +61,14 @@ to configure and build libgav1 and the extension's [JNI wrapper library][].
 [Ninja]: https://ninja-build.org
 [JNI wrapper library]: https://github.com/google/ExoPlayer/blob/release-v2/extensions/av1/src/main/jni/gav1_jni.cc
 
-## Build instructions (Windows) ##
+## Build instructions (Windows)
 
 We do not provide support for building this extension on Windows, however it
 should be possible to follow the Linux instructions in [Windows PowerShell][].
 
 [Windows PowerShell]: https://docs.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell
 
-## Using the extension ##
+## Using the module
 
 Once you've followed the instructions above to check out, build and depend on
 the extension, the next step is to tell ExoPlayer to use `Libgav1VideoRenderer`.
@@ -96,15 +96,15 @@ a custom track selector the choice of `Renderer` is up to your implementation.
 You need to make sure you are passing a `Libgav1VideoRenderer` to the player and
 then you need to implement your own logic to use the renderer for a given track.
 
-## Using the extension in the demo application ##
+## Using the module in the demo application
 
 To try out playback using the extension in the [demo application][], see
 [enabling extension decoders][].
 
 [demo application]: https://exoplayer.dev/demo-application.html
 [enabling extension decoders]: https://exoplayer.dev/demo-application.html#enabling-extension-decoders
 
-## Rendering options ##
+## Rendering options
 
 There are two possibilities for rendering the output `Libgav1VideoRenderer`
 gets from the libgav1 decoder:
@@ -129,7 +129,7 @@ gets from the libgav1 decoder:
 Note: Although the default option uses `ANativeWindow`, based on our testing the
 GL rendering mode has better performance, so should be preferred
 
-## Links ##
+## Links
 
 * [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.av1.*`
   belong to this module.

diff --git a/extensions/cast/README.md b/extensions/cast/README.md
@@ -1,30 +1,30 @@
-# ExoPlayer Cast extension #
+# ExoPlayer Cast extension
 
-## Description ##
+## Description
 
 The cast extension is a [Player][] implementation that controls playback on a
 Cast receiver app.
 
 [Player]: https://exoplayer.dev/doc/reference/index.html?com/google/android/exoplayer2/Player.html
 
-## Getting the extension ##
+## Getting the module
 
-The easiest way to use the extension is to add it as a gradle dependency:
+The easiest way to get the module is to add it as a gradle dependency:
 
 ```gradle
 implementation 'com.google.android.exoplayer:extension-cast:2.X.X'
 ```
 
-where `2.X.X` is the version, which must match the version of the ExoPlayer
-library being used.
+where `2.X.X` is the version, which must match the version of the other media
+modules being used.
 
 Alternatively, you can clone the ExoPlayer repository and depend on the module
 locally. Instructions for doing this can be found in ExoPlayer's
 [top level README][].
 
 [top level README]: https://github.com/google/ExoPlayer/blob/release-v2/README.md
 
-## Using the extension ##
+## Using the module
 
 Create a `CastPlayer` and use it to integrate Cast into your app using
 ExoPlayer's common `Player` interface.
diff --git a/extensions/cronet/README.md b/extensions/cronet/README.md
@@ -1,4 +1,4 @@
-# ExoPlayer Cronet extension #
+# ExoPlayer Cronet extension
 
 The Cronet extension is an [HttpDataSource][] implementation that uses
 [Cronet][].
@@ -14,24 +14,24 @@ for most use cases.
 [HttpDataSource]: https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/upstream/HttpDataSource.html
 [Cronet]: https://developer.android.com/guide/topics/connectivity/cronet
 
-## Getting the extension ##
+## Getting the module
 
-The easiest way to use the extension is to add it as a gradle dependency:
+The easiest way to get the module is to add it as a gradle dependency:
 
 ```gradle
 implementation 'com.google.android.exoplayer:extension-cronet:2.X.X'
 ```
 
-where `2.X.X` is the version, which must match the version of the ExoPlayer
-library being used.
+where `2.X.X` is the version, which must match the version of the other media
+modules being used.
 
 Alternatively, you can clone the ExoPlayer repository and depend on the module
 locally. Instructions for doing this can be found in ExoPlayer's
 [top level README][].
 
 [top level README]: https://github.com/google/ExoPlayer/blob/release-v2/README.md
 
-## Using the extension ##
+## Using the module
 
 ExoPlayer requests data through `DataSource` instances. These instances are
 obtained from instances of `DataSource.Factory`, which are instantiated and
@@ -47,16 +47,16 @@ new DefaultDataSourceFactory(
     /* baseDataSourceFactory= */ new CronetDataSource.Factory(...) );
 ```
 
-## Cronet implementations ##
+## Cronet implementations
 
 To instantiate a `CronetDataSource.Factory` you'll need a `CronetEngine`. A
 `CronetEngine` can be obtained from one of a number of Cronet implementations.
 It's recommended that an application should only have a single `CronetEngine`
 instance.
 
-### Available implementations ###
+### Available implementations
 
-#### Google Play Services ####
+#### Google Play Services
 
 By default, ExoPlayer's Cronet extension depends on
 `com.google.android.gms:play-services-cronet`, which loads an implementation of
@@ -72,7 +72,7 @@ includes one of the alternative Cronet implementations described below, you will
 not be able to instantiate a `CronetEngine` in this case. Your application code
 should handle this by falling back to use `DefaultHttpDataSource` instead.
 
-#### Cronet Embedded ####
+#### Cronet Embedded
 
 Cronet Embedded bundles a full Cronet implementation directly into your
 application. To use it, add an additional dependency on
@@ -84,7 +84,7 @@ use of Cronet Embedded may be appropriate if:
   not widely available.
 * You want to control the exact version of the Cronet implementation being used.
 
-#### Cronet Fallback ####
+#### Cronet Fallback
 
 There's also a fallback implementation of Cronet, which uses Android's default
 network stack under the hood. It can be used by adding a dependency on
@@ -98,7 +98,7 @@ you know when your application's `CronetEngine` has been obtained from the
 fallback implementation. In this case, avoid using it with ExoPlayer and use
 `DefaultHttpDataSource` instead.
 
-### CronetEngine instantiation ###
+### CronetEngine instantiation
 
 Cronet's [Send a simple request][] page documents the simplest way of building a
 `CronetEngine`, which is suitable if your application is only using the
@@ -121,7 +121,7 @@ still using it for other networking performed by your application.
 
 [Send a simple request]: https://developer.android.com/guide/topics/connectivity/cronet/start
 
-## Links ##
+## Links
 
 * [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.cronet.*`
   belong to this module.

diff --git a/extensions/ffmpeg/README.md b/extensions/ffmpeg/README.md
@@ -1,17 +1,17 @@
-# ExoPlayer FFmpeg extension #
+# ExoPlayer FFmpeg extension
 
 The FFmpeg extension provides `FfmpegAudioRenderer`, which uses FFmpeg for
 decoding and can render audio encoded in a variety of formats.
 
-## License note ##
+## License note
 
 Please note that whilst the code in this repository is licensed under
 [Apache 2.0][], using this extension also requires building and including one or
 more external libraries as described below. These are licensed separately.
 
 [Apache 2.0]: https://github.com/google/ExoPlayer/blob/release-v2/LICENSE
 
-## Build instructions (Linux, macOS) ##
+## Build instructions (Linux, macOS)
 
 To use this extension you need to clone the ExoPlayer repository and depend on
 its modules locally. Instructions for doing this can be found in ExoPlayer's
@@ -77,14 +77,14 @@ cd "${FFMPEG_EXT_PATH}/jni" && \
   "${FFMPEG_EXT_PATH}" "${NDK_PATH}" "${HOST_PLATFORM}" "${ENABLED_DECODERS[@]}"
 ```
 
-## Build instructions (Windows) ##
+## Build instructions (Windows)
 
 We do not provide support for building this extension on Windows, however it
 should be possible to follow the Linux instructions in [Windows PowerShell][].
 
 [Windows PowerShell]: https://docs.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell
 
-## Using the extension ##
+## Using the module
 
 Once you've followed the instructions above to check out, build and depend on
 the extension, the next step is to tell ExoPlayer to use `FfmpegAudioRenderer`.
@@ -116,15 +116,15 @@ then implement your own logic to use the renderer for a given track.
 [#2781]: https://github.com/google/ExoPlayer/issues/2781
 [Supported formats]: https://exoplayer.dev/supported-formats.html#ffmpeg-extension
 
-## Using the extension in the demo application ##
+## Using the module in the demo application
 
 To try out playback using the extension in the [demo application][], see
 [enabling extension decoders][].
 
 [demo application]: https://exoplayer.dev/demo-application.html
 [enabling extension decoders]: https://exoplayer.dev/demo-application.html#enabling-extension-decoders
 
-## Links ##
+## Links
 
 * [Troubleshooting using extensions][]
 * [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.ffmpeg.*`