From 8bbf36b06969a043e6a131101809573a925f2482 Mon Sep 17 00:00:00 2001 From: Alex Touchet Date: Mon, 30 Jul 2018 08:43:36 -0700 Subject: [PATCH] Update Readme --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index cd6e5a00..81f096af 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## Requirements So far the only supported and default backend is -[GStreamer](http://gstreamer.freedesktop.org/). +[GStreamer](https://gstreamer.freedesktop.org/). So in order to build this crate you need to install all [gstreamer-rs](https://github.com/sdroege/gstreamer-rs) dependencies for your specific platform as listed @@ -13,7 +13,7 @@ For Android there are some extra requirements. First of all, you need to install the appropriate toolchain for your target. The recommended approach is to install it through -[rustup](https://www.rustup.rs/). Taking `arm-linux-androideabi` as our example +[rustup](https://rustup.rs/). Taking `arm-linux-androideabi` as our example target you need to do: ```bash @@ -21,15 +21,15 @@ rustup target add arm-linux-androideabi ``` In addition to that, you also need to install the Android -[NDK](https://developer.android.com/ndk/guides/index.html#install). +[NDK](https://developer.android.com/ndk/guides/#install). The recommended NDK version is -[r16b](https://developer.android.com/ndk/downloads/older_releases.html). The -Android [SDK](https://developer.android.com/studio/index.html) is not mandatory +[r16b](https://developer.android.com/ndk/downloads/older_releases). The +Android [SDK](https://developer.android.com/studio/) is not mandatory but recommended for practical development. Once you have the Android NDK installed in your machine, you need to create what the NDK itself calls a -[standalone toolchain](https://developer.android.com/ndk/guides/standalone_toolchain.html). +[standalone toolchain](https://developer.android.com/ndk/guides/standalone_toolchain). ```bash $ ${ANDROID_NDK}/build/tools/make-standalone-toolchain.sh \ @@ -37,7 +37,7 @@ what the NDK itself calls a --install-dir=android-18-arm-toolchain --arch=arm ``` -The final thing for us to do is tell Cargo where to find the android linker, +The final thing for us to do is tell Cargo where to find the Android linker, which is in the standalone NDK toolchain we just created. To do that we configure the `arm-linux-androideabi` target in `.cargo/config` (or in `~/.cargo/config` if you want to apply the setting globaly) with the `linker` @@ -49,7 +49,7 @@ linker = "/android-18-toolchain/bin/arm-linux-androideab ``` This crate indirectly depends on -[libgstreamer_android_gen](https://github.com/ferjm/libgstreamer_android_gen): +[libgstreamer_android_gen](https://github.com/servo/libgstreamer_android_gen): a tool to generate the required `libgstreamer_android.so` library with all GStreamer dependencies for Android and some Java code required to initialize GStreamer on Android. If you want to generate your own `libgstreamer_android.so` @@ -57,7 +57,7 @@ bundle, check the documentation from that repo and tweak the [build script](https://github.com/ferjm/media/blob/master/build.rs#L19) accordingly. ## Build -For OSX, Windows and Linux, simply run: +For macOS, Windows, and Linux, simply run: ```bash cargo build ``` @@ -68,7 +68,7 @@ PKG_CONFIG_ALLOW_CROSS=1 cargo build --target=arm-linux-androideabi ## Running the examples ### Android -Make sure that you have [adb](https://developer.android.com/studio/command-line/adb.html) +Make sure that you have [adb](https://developer.android.com/studio/command-line/adb) installed and you have adb access to your Android device. Go to the `examples/android` folder and run: ```ssh