diff --git a/README.md b/README.md index ec9b4ee0..59b97fa5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# Rust on Android +Rust on Android += [![Rust](https://github.com/rust-windowing/android-ndk-rs/workflows/Rust/badge.svg)](https://github.com/rust-windowing/android-ndk-rs/actions) ![MIT license](https://img.shields.io/badge/License-MIT-green.svg) ![APACHE2 license](https://img.shields.io/badge/License-APACHE2-green.svg) @@ -14,6 +15,22 @@ Name | Description | Badges See [`ndk-examples`](./ndk-examples) for examples using the NDK and the README files of the crates for more details. +## Supported NDK versions + +`android-ndk-rs` aims to support at least the `LTS` and `Rolling Release` branches of the NDK, as described on [their wiki](https://github.com/android/ndk/wiki#supported-downloads). Additionally the `Beta Release` might be supported to prepare for an upcoming release. + +As of writing (2021-07-24) the following NDKs are tested: + +Branch | Version | Status | Working +-|-|:-:|:-: +r18 | 18.1.5063045 | _Deprecated_ | :x: +r19 | 19.2.5345600 | _Deprecated_ | :heavy_check_mark: +r20 | 20.1.5948944 | _Deprecated_ | :heavy_check_mark: +r21 | 21.4.7075529 | LTS | :heavy_check_mark: +r22 | 22.1.7171670 | Rolling Release | :heavy_check_mark: +r23 beta 1/2 | | Beta | :heavy_check_mark: +r23 beta 3 and beyond | | Beta | :x: Breaking on [#149](https://github.com/rust-windowing/android-ndk-rs/issues/149) :x: + ## Hello world Quick start for setting up a new project with support for Android. For communication with the Android framework in our native Rust application we require a `NativeActivity`. `ndk-glue` will do the necessary initialization when calling `main` but requires a few adjustments: @@ -87,9 +104,3 @@ Java Native Interface (JNI) allows executing Java code in a VM from native appli `ndk-examples` contains an `jni_audio` example which will print out all output audio devices in the log. - [`jni`](https://crates.io/crates/jni), JNI bindings for Rust - -## Winit and glutin -TODO shameless plug - -## Flutter -TODO shameless plug